Appearance
获取渠道活码统计数据
| 拥有此API的权限集 |
|---|
| SCRM-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.scrm.contact_card.realtime_stats/1.0.0 - 频率限制：
1s/1次
接口调试
请求参数
响应结果
暂无响应数据
请求参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| access_token | 是 | string | 专属token | ... |
| b_user_id | 否 | string | B 端操作人 ID；不传或传空时服务端使用 system 身份，并以 filters.follow_user_ids=["all"] 查询全部跟进员工范围 | 普通 B 端用户 ID 仍按其原有可见范围查询 |
| card_ids | 是 | array | string 类型的渠道活码 ID 列表 | 一次最多传入 200 个活码 ID，不允许为空数组 |
app_id已包含在access_token凭证中，由服务端从凭证中解析，调用方无需单独传递。接口会对重复的活码 ID 去重。
请求示例
json
{
"access_token": "xe_xxxxx",
"card_ids": [
"10001",
"10002"
]
}
b_user_id为可选参数。缺失或为空时，服务端在受控的活码统计链路中使用system，并向客户搜索服务传递filters.follow_user_ids=["all"]。这表示查询当前应用范围内、这些活码渠道关联的全部跟进员工客户关系；不会绕过活码渠道过滤。直接调用平台客户搜索接口时，b_user_id仍为必填，不能传空字符串。
返回参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| code | 是 | int | 状态码，0 表示成功，非 0 表示失败 | ... |
| msg | 是 | string | 状态信息 | ... |
| data | 是 | object | 返回值 | ... |
| data.list | 是 | array | 渠道活码统计列表 | 无数据时为空数组 |
data.list 渠道活码统计列表
| 参数名 | 类型 | 说明 | 备注 |
|---|---|---|---|
| card_id | string | 渠道活码 ID | 与请求中的活码 ID 对应 |
| total_add_count | int64 | 累计添加好友数 | 与 scrm.contact-card/card_list 的 total_add_count 口径一致；返回 JSON number；获取下游数据失败时为 0 |
| new_add_count | int64 | 首次通过该活码添加的新客户数 | 按 external_user_id 去重；取每个客户最早一条记录（比较 follow_user_createtime），该记录渠道为 s_<card_id> 时计入；返回 JSON number；获取下游数据失败或超时时为 0 |
| xiaoe_user_count | int | 当前活码关联的去重后小鹅用户数 | 仅统计非空 xiaoe_user_id，同一用户在不同活码下分别计数 |
| deal_user_count | int | 成交人数；统计 transaction_number > 0 的用户数 | ... |
| deal_amount | float | 成交金额，单位：元 | 由支付金额（分）汇总后换算为元 |
total_add_count是活码历史累计添加好友数，数据口径与scrm.contact-card/card_list返回值一致，不等价于当前客户关系数量xiaoe_user_count。服务端获取该下游统计失败时仅将total_add_count降级为0，不影响已有实时统计字段。
new_add_count是首次归因口径：该活码带来了多少新客。计算方式为——按external_user_id去重后，取每个客户follow_user_createtime最早的那条记录，若该记录的follow_user_channel_id精确等于s_<card_id>，则该客户计入本活码。约束：仅统计有效记录（row_state = 0）；仅精确匹配s_<card_id>，非s_前缀的渠道值（如中文渠道名）天然不计入；数据源为db_scrm.dor_scrm_customer，经scrm-platform-service的customers/stats/distinct-count接口查询。该字段与
total_add_count、xiaoe_user_count口径不同、不可互换：
total_add_count是累计添加次数，同一客户被同一活码重复添加会重复计数，因此通常 ≥new_add_count；new_add_count按客户去重且只看首次归属，老客户后续再次进入该活码不计入；xiaoe_user_count是当前仍关联的去重小鹅用户数，会随客户流失下降，而new_add_count是历史累计值、只增不减。每个活码对应一次独立的
new_add_count查询，单卡查询失败或超时时仅该卡new_add_count为0，不影响其它活码、也不影响其它字段。
xiaoe_user_count按每个活码独立统计当前关联的非空xiaoe_user_id，同一活码内重复用户只计一次；同一用户在不同活码下分别计数。该字段基于客户关系查询结果计算，与成交数据补充独立，即使成交数据下游失败也不影响用户数。
json
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"card_id": "10001",
"total_add_count": 250,
"new_add_count": 180,
"xiaoe_user_count": 123,
"deal_user_count": 12,
"deal_amount": 199.00
},
{
"card_id": "10002",
"total_add_count": 0,
"new_add_count": 0,
"xiaoe_user_count": 0,
"deal_user_count": 0,
"deal_amount": 0
}
]
}
}错误说明
| 场景 | 说明 |
|---|---|
| 请求参数错误 | access_token 缺失，或 card_ids 为空；b_user_id 缺失或为空不会导致该开放接口请求失败，服务端会在统计链路内使用 system |
| 活码数量超限 | 单次请求的 card_ids 超过 200 个 |
| 查询失败 | 下游客户数据查询失败时，接口返回错误信息；成交统计字段可能按服务端策略降级为 0 |
用量建议
- 单次请求活码数建议 ≤ 20。
new_add_count的每个活码对应一次独立的下游查询（distinct-count一次只返回一个渠道的计数），活码越多总耗时越长。 - 单个活码的
new_add_count查询耗时量级约 0.5 秒（该企业所在分区首次被访问时约为预热后的 2 倍）。接口整体预算 15 秒，服务端按有界并发查询。