Appearance
获取渠道活码离线统计数据
| 拥有此API的权限集 |
|---|
| SCRM-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.scrm.contact_card.offline_stats/1.0.0 - 频率限制：
1s/10次
接口调试
请求参数
响应结果
暂无响应数据
请求参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| access_token | 是 | string | 专属token | ... |
| b_user_id | 否 | string | 预留参数，本接口不参与计算 | 传值不影响返回结果 |
| card_ids | 是 | array | string 类型的渠道活码 ID 列表 | 一次最多传入 200 个活码 ID，不允许为空数组 |
app_id已包含在access_token凭证中，由服务端从凭证中解析，调用方无需单独传递。接口会对重复的活码 ID 去重。
请求示例
json
{
"access_token": "xe_xxxxx",
"card_ids": [
"10001",
"10002"
]
}返回参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| code | 是 | int | 状态码，0 表示成功，非 0 表示失败 | ... |
| msg | 是 | string | 状态信息 | 成功时为 ok |
| data | 是 | object | 返回值 | ... |
| data.list | 是 | array | 渠道活码离线统计列表 | 无数据时为空数组 |
data.list 渠道活码离线统计列表
| 参数名 | 类型 | 说明 | 备注 |
|---|---|---|---|
| card_id | string | 渠道活码 ID | 与请求中的活码 ID 对应 |
| total_add_count | int64 | 累计添加好友数 | 与实时统计接口 xe.scrm.contact_card.realtime_stats/1.0.0 的 total_add_count 口径一致 |
| new_add_count | int64 | 首次通过该活码添加的新客户数 | 与实时统计接口的 new_add_count 口径一致 |
| xiaoe_user_count | int | 去重后小鹅用户数 | 与实时统计接口的 xiaoe_user_count 口径一致；超过 5000 客户的活码可能偏小 |
| deal_user_count | int | 成交人数 | 与实时统计接口的 deal_user_count 口径一致 |
| deal_amount | float | 成交金额，单位：元 | 与实时统计接口的 deal_amount 口径一致 |
| stat_date | string | 该条数据实际采集的日期，格式 yyyyMMdd | 用于判断数据新鲜度，见下方说明 |
| stat_at | int64 | 该条数据实际采集的时间，Unix 秒 | 与 stat_date 含义相同，精度更高 |
本接口的数据来自每日离线快照，不是实时查询。 服务端每天定时遍历店铺下的全部渠道活码，把上述指标落成快照；调用本接口时直接读取快照返回，不会实时请求下游，因此响应速度与请求的活码数量基本无关，不需要像实时统计接口那样控制单次请求的活码数。
数据最多滞后 24 小时，且采集失败时不会写入新值，会保留上一次成功采集的结果。因此「接口返回了这条活码」不等于「这是今天的数据」——请以
stat_date/stat_at为准。若某张活码的stat_date不是今天，说明当天的采集对该活码失败了，返回的是历史值。请求了但服务端没有快照的活码，不会出现在
data.list里——接口不会为它返回一条全0的记录，也不会因此报错。这与实时统计接口的行为不同（实时接口会为每张请求的活码返回一项，取不到下游数据时降级为0）。调用方如需确认某张活码是否有离线数据，请判断它的card_id是否出现在data.list中。全新创建、当天尚未被快照任务覆盖的活码属于这种情况。
json
{
"code": 0,
"msg": "ok",
"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,
"stat_date": "20240101",
"stat_at": 1704067200
},
{
"card_id": "10002",
"total_add_count": 0,
"new_add_count": 0,
"xiaoe_user_count": 0,
"deal_user_count": 0,
"deal_amount": 0,
"stat_date": "20240101",
"stat_at": 1704067200
}
]
}
}错误说明
| 场景 | 说明 |
|---|---|
| 请求参数错误 | access_token 缺失，或 card_ids 为空 |
| 活码数量超限 | 单次请求的 card_ids 超过 200 个 |
| 活码无离线数据 | 不会报错。该活码不会出现在 data.list 中，请按「请求了但没有快照」处理 |
| 快照服务异常 | 离线快照任务本身失败时，本接口仍会正常返回上一次的快照；任务是否成功请以任务侧日志为准，本接口无法反映 |
用量建议
- 本接口只读快照，单次请求建议仍不超过 200 个（与服务端限制一致）。
- 需要当天最新的数据，或需要查询当天新建、尚未被快照覆盖的活码，请使用实时统计接口
xe.scrm.contact_card.realtime_stats/1.0.0。 - 需要批量拉取全店活码的数据，用本接口；实时统计接口在活码数量多时耗时会长得多。