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

    • 直播投稿数据

    收藏
    我的收藏
    获取挂载绑定的抖音号在一段时间内在指定的宿主端上直播场次和有开播天数，使用效果和（小程序-数据-数据中心-直播-开播数据）页面一致。信息包括：直播场次，开播天数（不知道如何获取自挂载绑定的抖音号列表？请戳这里获取小程序自挂载绑定的抖音号列表），目前平台侧暂未开放获取达人挂载抖音号的接口，需开发者自行传入相关抖音号。

    使用限制

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

    接口

    获取挂载绑定抖音号在一段时间内在指定宿主端上开播的历史直播间列表，以及累计开播场次和最大开播天数。
    最大开播天数是指所选抖音号列表中，开播天数最长的那个抖音号所对应的开播天数。

    接口说明

      •业务场景：此open_api支持查看挂载直播间的相关数据。
      •注意事项：此open_api获取的是离线数据，支持查看近90天内开播的直播间数据，当天开播的直播间数据无法在当天查看，请在下一天查看。

    基本信息

    名称
    描述
    HTTP URL
    https://open.douyin.com/api/platform/v2/data_analysis/query_short_live_id_with_awemeid/
    HTTP Method
    POST
    Scope
    无
    权限要求
    服务商代调用场景下，需商家授予数据分析权限集

    请求头

    名称
    类型
    必填
    描述
    access-token
    string
    是
    token获取接口（其中服务商代调用场景的token获取接口）

    请求参数

    名称
    类型
    是否必填
    描述
    默认值
    start_time
    int64
    是
    开始时间，必须是昨天以前的某个时间戳，传入当天的整点时间戳，例如要查询2023年3月20号以来的数据，start_time就传2023-03-20 00:00:00对应的时间戳
    无
    end_time
    int64
    是
    结束时间，必须是昨天以前的某个时间戳，传入当天的整点时间戳，例如要查询截止到2023年3月20号的数据，end_time就传2023-03-20 00:00:00对应的时间戳
    无
    host_name
    string
    否
    宿主APP，douyin-抖音；douyin_lite-抖音lite；toutiao-今日头条；tt_lite-今日头条lite；huoshan-抖音火山版；不传表示查全部端数据
    无
    query_bind_type
    int64
    是
    查询数据的挂载类型，1-自挂载数据，0-自挂载数据+达人挂载数据，4-自挂载数据+达人挂载数据+UGC挂载数据，目前该参数只能传0或1或4，传其他参数会产生非预期的结果
    1
    aweme_short_id_list
    array
    是
    没有抖音号列表，需要传递 空的字符串数组，如果传递抖音号列表限制长度在200以内，即一次性最多查询 200个抖音号 所对应的自挂载，达人挂载直播间所产生的数据
    无
    query_data_type
    int64
    否
    查询的列表类型，传4表示查询短视频发布数据，传5表示查询直播开播数据，不传表示同时查询两者的信息
    无

    请求示例

    //查询"129273123"，"112273113"这两个抖音号在 2023年3月20日 到 2023年3月21日 在抖音端开播的自挂载，达人挂载直播间数据
{
  "start_time": 1679241600,
  "end_time": 1679328000,
  "host_name": "douyin",
  "query_bind_type": 0,
  "aweme_short_id_list": ["129273123","112273113"],
  "query_data_type":5
}

//查询"129273123"，"112273113"这两个抖音号在 2023年3月20日 到 2023年3月21日 在全部宿主端开播的自挂载直播间数据
{
  "start_time": 1679241600,
  "end_time": 1679328000,
  "query_bind_type": 1,
  "aweme_short_id_list": ["129273123","112273113"],
  "query_data_type":5
}

    响应参数

    名称
    类型
    是否必填
    描述
    默认值
    err_no
    int64
    是
    错误码
    ​
    err_msg
    string
    是
    错误信息
    ​
    log_id
    string
    是
    log_id，用于向内部开发人员进行反馈
    ​
    data
    object
    是
    响应结果（具体结构见下方正常示例）
    ​

    响应示例

    正常示例

    {
    "err_no":0,
    "err_msg":"success",
    "data":{
      //发布的短视频数据(仅在查询自挂载数据时有值)
      "item_data":{
      },
      //发布的直播间数据(仅在查询自挂载数据时有值)
      "live_data":{
        // key:抖音号  value:该抖音号对应的直播间ID列表
        "129273123":["7169582199207939932","7169582199683939932"],
        "112273113":["7169892199207939932","7169582129207939932"]
      },
      //总览数据(自挂载和达人挂载数据均有值)
      "over_view_data":{
          "room_session_cnt": "4",   //开播场次
          "room_broadcast_cnt": "2", //开播天数
      }
    },
    "log_id":xxx
}

    异常示例

    {
    "err_no":11009,
    "err_msg":参数不合法或缺少参数,
    "log_id":xxx,
    "data":{
    }
}

    错误码

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