# 获取直播推广统计数据

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getpromoterlivestats

可通过该接口获取推客推广直播的相关数据——直播的转发和用户观看统计数据

(注:2025年10月25功能上线,这个时间点之后的数据才有效)

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/league/headsupplier/promoteraction/getlivestats?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填示例说明
sharer_appidstringwxab1eaxxxxxx推客appid
live_idstring123456789直播ID
start_timenumber1735084800查询范围的开始时间戳(秒)
end_timenumber1735171200查询范围的结束时间戳(秒)

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码
errmsgstring-错误信息
share_countnumber5转发人次
share_user_countnumber1转发人数(同一用户算一次)
join_countnumber3进直播人次
join_user_countnumber2进直播人数(同一用户算一次)

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "sharer_appid": "wxab1eaxxxxxx",
    "live_id": "123456789",
    "start_time": 1735084800,
    "end_time": 1735171200
}

返回示例

{
    "errcode": 0,
    "errmsg": "",
    "share_count": 5,
    "share_user_count": 1,
    "join_count": 3,
    "join_user_count": 2
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10024000参数错误检查参数

# 7. 适用范围

本接口支持「联盟带货机构」账号类型调用。其他账号类型如无特殊说明,均不可调用。

注:2025年10月25功能上线,这个时间点之后的数据才有效