Articles on: Developers & API
This article is also available in:

API & data structure

There are 2 ways to connect to our API:

Using Zapier -
Direct API calls - documentation and example available here:

IdUnique ID.
idunicData collected for the unique ID field.
genderData collected for the gender field.
usernameData collected for the username field.
firstNameData collected for the first name field.
lastNameData collected for the last name field.
emailData collected for the email field.
dobData collected for the date of birth field.
addressData collected for the address field.
cpData collected for the postcode field.
townData collected for the town field.
countryData collected for the country field.
phoneNumberData collected for the phone number field.
companyNameData collected for the company name field.
websiteData collected for the website field.
optinNewsletterData collected for the optin checkbox.
customTextData collected for the custom text field.
selectValueData collected for the custom dropdown menu.
customCheckboxData collected for the custom checkbox list
profilProfile result if personality test / quiz / survey app.
profilUidProfile unique ID if personality test/ quiz / survey app.
scoreUser Score if score based app.
prizeUidPrize Uid, if no gift won this return the string “lost”.
prizeTitlePrize Title recorded when the user has won a gift.
codeCode won by the user.
sessionIdUser Session ID.
ipAddressUser IP Address.
countryCodeCountry code based on the user IP (FR for example).
connectionCountryCountry based on the user IP (France for example).
timeTakenTime spent by the user on the app.
referralTraffic source referral.
dateServer timestamp (2020-11-12T19:09:32+01:00 for example).
dateWithTimezoneTimestamp converted to the timezone set up for the app (2020-11-12T17:09:32+01:00 for example).
publisherIdPublisher id received during the user session.

Updated on: 02/06/2023

Was this article helpful?

Share your feedback


Thank you!