API clienti e metriche

Registrare un cliente

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

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

• externalId: il tuo ID per il cliente. Obbligatorio.
• hit: la visita con cui è arrivato. Obbligatorio. Un cliente viene legato a una visita, una sola volta.
• displayName: facoltativo, un nome che vede il tuo team; senza, il cliente è un animale anonimo.

Comunicare cosa fa

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: il cliente registrato; oppure invia hit per un cliente che non hai registrato.
• requestId: il tuo ID per questa comunicazione. Lo stesso conta una volta, quindi riprovare è sicuro.
• metrics: fino a 20, ognuna con il code di una metrica e il value di cui si è mossa (negativo per togliere).

Buono a sapersi

• Crea prima le metriche in Prestazioni › Clienti › Metriche; un codice sconosciuto viene rifiutato.
• Le offerte con quota ricavi clienti pagano al partner del cliente la sua quota di ogni movimento.