API de clientes e métricas

Registar um cliente

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

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

• externalId: o seu próprio ID para o cliente. Obrigatório.
• hit: a visita com que chegou. Obrigatório. Um cliente fica ligado a uma visita, uma só vez.
• displayName: opcional, um nome que a sua equipa vê; sem ele o cliente é um animal anónimo.

Comunicar o que faz

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: o cliente registado; ou envie hit para um cliente que não registou.
• requestId: o seu próprio ID para esta comunicação. O mesmo conta uma vez, por isso repetir é seguro.
• metrics: até 20, cada uma com o code de uma métrica e o value em que se moveu (negativo para retirar).

Bom saber

• Crie primeiro as métricas em Desempenho › Clientes › Métricas; um código desconhecido é recusado.
• As ofertas com parte da receita de clientes pagam ao parceiro do cliente a sua parte de cada movimento.