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

Key	Description
Id	Unique ID.
idunic	Data collected for the unique ID field.
gender	Data collected for the gender field.
username	Data collected for the username field.
firstName	Data collected for the first name field.
lastName	Data collected for the last name field.
email	Data collected for the email field.
dob	Data collected for the date of birth field.
address	Data collected for the address field.
cp	Data collected for the postcode field.
town	Data collected for the town field.
country	Data collected for the country field.
phoneNumber	Data collected for the phone number field.
companyName	Data collected for the company name field.
website	Data collected for the website field.
optinNewsletter	Data collected for the optin checkbox.
customText	Data collected for the custom text field.
customFormat	Data collected for the custom format field.
profil	Profile result if personality test / quiz / survey app.
profilUid	Profile unique ID if personality test/ quiz / survey app.
score	User Score if score based app.
prizeUid	Prize Uid, if no prize won this return the string “lost”.
prizeTitle	Prize Title recorded when the user has won a prize.
prizeRef	Prize Refrence recorded when the user has won a prize.
code	Code won by the user.
date	Server timestamp (2020-11-12T19:09:32+01:00 for example).
publisherId	The ID of the publisher.
sessionId	User Session ID.
countryCode	Country code based on the user IP (FR for example).
selectValue	Data collected for the custom dropdown menu.
selectValue2	Data collected for the 2nd custom dropdown menu.
customCheckbox	Data collected for the custom checkbox list
timeTaken	Time spent by the user on the app.
referral	Traffic source referral.
updatedAt	The date when the data have been updated.
connectionCountry	Country based on the user IP (France for example).
updatedAtTimeStamp	A timestamp when the data have been updated.
dateWithTimezone	Timestamp converted to the timezone set up for the app (2020-11-12T17:09:32+01:00 for example).
locale	The application language used during the user experience.
ipAddress	User IP address.

Updated on: 31/07/2024