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, на яке вона змінилася (від'ємне — щоб забрати).

Корисно знати

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