Articles sur : Développeurs et API
Cet article est aussi disponible en :

API & Structure des données

Il existe 3 façons de se connecter à notre API :



Données renvoyées par l’API


L’API renvoie un enregistrement par participation : les données des champs du formulaire, le résultat (score, profil ou gain) et les champs techniques, comme indiqué dans le tableau ci-dessous. Elle ne renvoie pas le détail des réponses données par un joueur à chaque question d’un quiz ou d’un sondage. Pour consulter toutes les réponses, utilisez l’export des données de votre application : chaque question y dispose de sa propre colonne.


Vous souhaitez afficher les résultats en direct sur grand écran, lors d’un événement par exemple ? Utilisez le tableau de classement des participants : il dispose de son propre lien, se met à jour en temps réel après chaque participation et peut être affiché sur un écran séparé.


Structure des données de l’API


Voici comment renseigner la colonne Exemple de données à partir des formats courants pour ces types de champs :


Clé

Description

Exemple de données

Id

Identifiant unique.

123456

appId

Identifiant de l’application.

123456

appRef

Référence interne de l’application.

my campaign

idunic

Données recueillies dans le champ « Identifiant unique ».

ABC123XYZ

gender

Données recueillies dans le champ « Civilité ».

Male / Female / Prefer not à say

username

Données recueillies dans le champ « Nom d’utilisateur ».

johndoe

firstName

Données recueillies dans le champ « Prénom ».

John

lastName

Données recueillies dans le champ « Nom ».

Doe

email

Données recueillies dans le champ « Adresse e-mail ».

johndoe@example.com

dob

Données recueillies dans le champ « Date de naissance ».

1990-01-01T00:00:00+01:00

address

Données recueillies dans le champ « Adresse postale ».

123 Main St, Apt 4B

cp

Données recueillies dans le champ « Code postal ».

12345

town

Données recueillies dans le champ « Ville ».

New York

country

Données recueillies dans le champ « Pays ».

United States

phoneNumber

Données recueillies dans le champ « Numéro de téléphone ».

+12025550199

companyName

Données recueillies dans le champ « Nom de la société ».

Example Corp.

website

Données recueillies dans le champ « Adresse du site internet ».

https://www.example.com

optinNewsletter

Données recueillies via la case à cocher de consentement.

true / false

customText

Données recueillies dans le champ de texte personnalisé.

Custom participation value

customFormat

Données recueillies dans le champ au format personnalisé.

Custom participation value

profil

Profil obtenu dans une application de type test de personnalité, quiz ou sondage.

Explorer

profilUid

Identifiant unique du profil obtenu dans une application de type test de personnalité, quiz ou sondage.

EXPL123

score

Score de l’utilisateur dans une application basée sur un système de points.

85

prizeUid

Identifiant unique du gain. Si aucun lot n’a été gagné, ce champ renvoie lost.

0f8e4a298ba5c036c7db5e5ef1ce422e85ceb5e3 / lost

prizeTitle

Nom du gain enregistré lorsque l’utilisateur remporte un lot.

Gold Membership

prizeRef

Référence du gain enregistrée lorsque l’utilisateur remporte un lot.

GOLD2023

code

Code remporté par l’utilisateur.

WIN12345

date

Horodatage du serveur.

2024-11-10T19:09:32+01:00

publisherId

Identifiant de l’éditeur.

PUB123

sessionId

Identifiant de session de l’utilisateur.

Session_296c9d74f159eacf374a2ac4e9d6f028

countryCode

Code du pays déterminé à partir de l’adresse IP de l’utilisateur.

FR

selectValue

Données recueillies via le menu déroulant personnalisé.

Option A

selectValue2

Données recueillies via le deuxième menu déroulant personnalisé.

Option B

customCheckbox

Données recueillies via la liste personnalisée de cases à cocher. Si plusieurs options sont sélectionnées, les valeurs sont séparées par une barre verticale. (∣)

Option 1 ∣ Option 2

timeTaken

Temps passé par l’utilisateur sur l’application, en secondes.

360

levelsPlayed

Nombre total de niveaux terminés par l’utilisateur dans les expériences Combo™, Parcours Dynamique™ ou Calendrier De L'Avent. Renvoie null pour tous les autres types de jeux.

123456

referral

Référence de la source du trafic.

direct

updatedAt

Date de mise à jour des données.

2024-11-10T19:09:32+01:00

connectionCountry

Pays déterminé à partir de l’adresse IP de l’utilisateur.

France

updatedAtTimeStamp

Horodatage de la mise à jour des données.

1731262172

dateWithTimezone

Horodatage converti dans le fuseau horaire de l’application.

2024-11-10T17:09:32+01:00

played

Indicateur qui renvoie true si l’utilisateur a joué au jeu, et false dans le cas contraire.

true / false

locale

Langue de l’application utilisée lors de la participation de l’utilisateur.

en

ipAddress

Adresse IP de l’utilisateur.

192.168.1.1

Mis à jour le : 19/10/2026

Cet article a-t-il répondu à vos questions ?

Partagez vos commentaires

Annuler

Merci !