API клиентов и метрик

Регистрация клиента

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

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

• externalId: ваш собственный ID клиента. Обязательно.
• hit: переход, с которым он пришёл. Обязательно. Клиент привязывается к одному переходу, один раз.
• displayName: необязательно, имя, которое видит команда; без него клиент — анонимное животное.

Сообщение о действиях

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: зарегистрированный клиент; или отправьте hit для клиента, которого вы не регистрировали.
• requestId: ваш собственный ID этого сообщения. Один и тот же засчитывается один раз, поэтому повтор безопасен.
• metrics: до 20, у каждой code метрики и value, на которое она изменилась (отрицательное — чтобы забрать).

Полезно знать

• Сначала создайте метрики в Эффективность › Клиенты › Метрики; неизвестный код отклоняется.
• Офферы с долей от выручки клиентов платят партнёру клиента его долю с каждого движения.