クライアントとメトリクスの 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: クライアントが来たときのヒット。必須です。クライアントは 1 つのヒットに 1 回だけ結び付けられます。
• 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。同じものは 1 回だけ数えられるので、再試行しても安全です。
• metrics: 最大 20 個。それぞれメトリクスの code と、変動した value（取り消すときはマイナス）を持ちます。

知っておくと便利なこと

• 先にパフォーマンス › クライアント › メトリクスでメトリクスを作成してください。不明なコードは却下されます。
• クライアントのレベニューシェアがあるオファーは、変動のたびにクライアントのパートナーに取り分を支払います。