客户和指标 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。相同的 ID 只计一次，因此重试是安全的。
• metrics：最多 20 个，每个包含指标的 code 和其变化的 value（负数表示扣回）。

须知

• 请先在效果 › 客户 › 指标中创建指标；未知代码会被拒绝。
• 设有客户收入分成的优惠，会从每次变动中向客户的合作伙伴支付其份额。