• OpenAPI 简介
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 支付
  • 运营
  • 解决方案
  • 素材库
  • 数据分析
  • 用户分析
  • 交易分析
  • 短视频分析
  • 直播分析
  • 直播投稿数据
  • 直播间详细数据
  • 主播分析
  • 小房子直播分析
  • 留资分析
  • 服务类目
  • 直播间能力
  • 视频关键词管理
  • 能力申请
  • 页面结构自定义
  • 普通二维码绑定
  • 生活服务
  • 垂直行业
  • 其它
  • 主播分析

    收藏
    我的收藏

    接口说明

    获取小程序的直播-主播分析数据。数据内容与“小程序控制台-数据-数据中心-直播-主播分析”模块保持一致。

    使用限制

    • 每日 14:00 前更新前一日数据
    • 只能查询昨天以前,且是近90天内的数据
    • 串行调用,控制该open_api的调用频率,并发太高可能触发限流

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/api/platform/v2/data_analysis/query_live_with_short_id/
    HTTP Method
    POST
    权限要求

    服务商代调用场景下,需商家授予数据分析权限

    请求参数

    请求头
    access-token必填String
    当非服务商时,调用https://open.douyin.com/oauth/client_token/生成的token
    当服务商时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
    content-type必填String
    示例:application/json
    固定值"application/json"
    Body
    end_time必填Int64

    结束时间,必须是昨天以前的某个时间戳

    page_no必填Int64

    分页

    page_size必填Int64

    分页大小,最大50

    start_time必填Int64

    开始时间,必须是昨天以前的某个时间戳

    aweme_short_id_listArray<String>

    选择的抖音号列表

    host_nameString

    宿主APP,douyin-抖音;douyin_lite-抖音lite;toutiao-今日头条;tt_lite-今日头条lite;huoshan-抖音火山版;

    请求示例
    curl --location --request POST 'https://open.douyin.com/api/platform/v2/data_analysis/query_live_with_short_id/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"host_name":"douyin","aweme_short_id_list":[],"page_no":1,"page_size":10,"start_time":620444184735,"end_time":1644457405}'

    响应参数

    Body展开全部子属性
    err_msg必填String

    错误信息

    err_no必填Int32

    错误码

    log_id必填String

    排查错误的logId

    dataStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "data": { "ShortDataList": [ { "Data": { "PayCustomerCnt": 0, "PayOrderAmount": 0, "RoomDuration": 37532, "RoomHighestOnlineCount": 6, "RoomNewFans": 0, "RoomSessionCnt": 58, "RoomWatchRate": 5624, "OrderAmount": 100 }, "ShortInfo": { "AccountType": 1, "Avat": "https://p3.douyinpic.com/aweme/100x100/aweme-avatar/tos-cn-avt-0015_87906d32936af5f7c66d8bdf10149a7f.jpeg?from=3782654143", "AwemeShortID": "lmn7455", "Nickname": "喵喵喵喵" } } ], "Total": 5 }, "err_msg": "success", "err_no": 0, "log_id": "xxx" }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    200-1
    系统错误
    建议重试,若多次重试失败,可向平台反馈该问题
    20011009
    参数不合法或缺少参数
    检查参数合法性,注意参数类型以及是否缺少必要参数
    20028001003
    access_token无效
    请检查access_token
    20028001007
    必填字段缺失
    请检查必填字段
    20028001008
    access_token过期
    请刷新或重新授权access_token