This article is also available in:
Our REST API only allows to fetch (GET) the data collected through your data collection form set up in your game.

The different API keys available are in bold

ID (mandatory) - Unique ID
quizzUid (mandatory) - Returned if the game is a quiz. Quiz Unique ID
appUid (mandatory) - Returned if the game is anything but a quiz. Application unique ID.
appType (mandatory) - The Application type (quizz, scratch, memory etc...)
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
selectValue - Data collected for the custom dropdown menu
customCheckbox - Data collected for the custom checkbox list
profil - Profile result if personality test / quiz / poll app
profilDesc - Profile description if personality test/ quiz / poll app
score - User Score if score based app
giftUid - Gift Uid, if no gift won this return the string “lost”
giftTitle - Gift Title recorded when the user has won a gift
sessionId (mandatory) - User Session ID
ipAddress (mandatory) - User IP Address
countryCode (mandatory) - Country code based on the user IP (FR for example)
connectionCountry (mandatory) - Country based on the user IP (France for example)
timeTaken - Time spent by the user on the app
referral - Traffic source referral
date (mandatory) - Server timestamp (2020-11-12T19:09:32+01:00)
dateWithTimezone (mandatory) - Timestamp converted to the timezone set up for the app (2020-11-12T17:09:32+01:00)

(mandatory) = The data is mandatorily collected.
Was this article helpful?
Cancel
Thank you!