API & data structure
There are 3 ways to connect to our API:
Using Zapier - https://zapier.com/
Using Make - https://www.make.com/
Direct API calls - documentation and example available here: https://endpoint.drimify.com/api/docs?ui=re_doc
Here’s how you could fill in the Data Example column based on common formats for these types of fields:
Using Zapier - https://zapier.com/
Using Make - https://www.make.com/
Direct API calls - documentation and example available here: https://endpoint.drimify.com/api/docs?ui=re_doc
Here’s how you could fill in the Data Example column based on common formats for these types of fields:
| Key | Description | Data Example |
|---|---|---|
| Id | Unique ID. | 123456 |
| idunic | Data collected for the unique ID field. | ABC123XYZ |
| gender | Data collected for the gender field. | Male / Female / Prefer not to say |
| username | Data collected for the username field. | johndoe |
| firstName | Data collected for the first name field. | John |
| lastName | Data collected for the last name field. | Doe |
| Data collected for the email field. | johndoe@example.com | |
| dob | Data collected for the date of birth field. | 1990-01-01T00:00:00+01:00 |
| address | Data collected for the address field. | 123 Main St, Apt 4B |
| cp | Data collected for the postcode field. | 12345 |
| town | Data collected for the town field. | New York |
| country | Data collected for the country field. | United States |
| phoneNumber | Data collected for the phone number field. | +12025550199 |
| companyName | Data collected for the company name field. | Example Corp. |
| website | Data collected for the website field. | https://www.example.com |
| optinNewsletter | Data collected for the opt-in checkbox. | on / off |
| customText | Data collected for the custom text field. | Custom entry value |
| customFormat | Data collected for the custom format field. | Custom entry value |
| profil | Profile result if personality test/quiz/survey app. | Explorer |
| profilUid | Profile unique ID if personality test/quiz/survey app. | EXPL123 |
| score | User Score if score-based app. | 85 |
| prizeUid | Prize UID, if no prize won this returns "lost". | 0f8e4a298ba5c036c7db5e5ef1ce422e85ceb5e3 / lost |
| prizeTitle | Prize Title recorded when the user has won a prize. | Gold Membership |
| prizeRef | Prize Reference recorded when the user has won a prize. | GOLD2023 |
| code | Code won by the user. | WIN12345 |
| date | Server timestamp. | 2024-11-10T19:09:32+01:00 |
| publisherId | The ID of the publisher. | PUB123 |
| sessionId | User Session ID. | Session_296c9d74f159eacf374a2ac4e9d6f028 |
| countryCode | Country code based on the user IP. | FR |
| selectValue | Data collected for the custom dropdown menu. | Option A |
| selectValue2 | Data collected for the 2nd custom dropdown menu. | Option B |
| customCheckbox | Data collected for the custom checkbox list. If multiple options are selected, values will be separated by a vertical bar ( | ). | Option 1 | Option 2 |
| timeTaken | Time spent by the user on the app in seconds. | 360 |
| referral | Traffic source referral. | direct |
| updatedAt | The date when the data was updated. | 2024-11-10T19:09:32+01:00 |
| connectionCountry | Country based on the user IP. | France |
| updatedAtTimeStamp | A timestamp when the data was updated. | 1731262172 |
| dateWithTimezone | Timestamp converted to the app’s timezone. | 2024-11-10T17:09:32+01:00 |
| locale | The application language used during the user experience. | en |
| ipAddress | User IP address. | 192.168.1.1 |
Updated on: 11/11/2024
Thank you!