API de clientes y métricas

Registrar un cliente

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

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

• externalId: tu propio ID para el cliente. Obligatorio.
• hit: la visita con la que llegó. Obligatorio. Un cliente se vincula a una visita, una sola vez.
• displayName: opcional, un nombre que ve tu equipo; sin él, el cliente es un animal anónimo.

Informar de lo que hace

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: el cliente registrado; o envía hit para un cliente que no registraste.
• requestId: tu propio ID para este informe. El mismo cuenta una vez, así que repetir es seguro.
• metrics: hasta 20, cada una con el code de una métrica y el value que se movió (negativo para restar).

Bueno saber

• Crea primero las métricas en Rendimiento › Clientes › Métricas; un código desconocido se rechaza.
• Las ofertas con parte de ingresos de clientes pagan al socio del cliente su parte de cada movimiento.