API clients et métriques

Enregistrer un client

POST https://<your workspace address>/track/clients
x-api-key: your API key

{ "externalId": "user-881", "hit": "h1.…", "displayName": "Jane D." }

• externalId : votre propre ID pour le client. Obligatoire.
• hit : la visite avec laquelle il est venu. Obligatoire. Un client est lié à une visite, une seule fois.
• displayName : facultatif, un nom que voit votre équipe ; sans lui, le client est un animal anonyme.

Déclarer ce qu’il fait

POST https://<your workspace address>/track/clients/movements

{
  "externalClientId": "user-881",
  "requestId": "ledger-77310",
  "metrics": [ { "code": "tokens_spent", "value": 120 }, { "code": "deposits", "value": 49.9 } ]
}

• externalClientId : le client enregistré ; ou envoyez hit pour un client que vous n’avez pas enregistré.
• requestId : votre propre ID pour cette déclaration. Le même ne compte qu’une fois, réessayer est donc sans risque.
• metrics : jusqu’à 20, chacune avec le code d’une métrique et la value dont elle a bougé (négative pour reprendre).

Bon à savoir

• Créez d’abord les métriques dans Performance › Clients › Métriques ; un code inconnu est refusé.
• Les offres avec une part des revenus clients versent au partenaire du client sa part de chaque mouvement.