接口说明

获取挂载对应小程序的短视频在一段时间范围内产生的（互动/经营）指标，数据内容与“小程序控制台-数据-数据中心-短视频”页面保持一致。可支持用抖音号查询，用抖音号查询则表示获取此小程序自挂载绑定的抖音号所发布的挂载该小程序的短视频在一段时间范围内产生的（互动/经营）指标。

使用限制

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

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/platform/v2/data_analysis/query_video_data/
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

结束时间，必须是昨天以前的某个时间戳，最好是传入当天的整点时间戳，例如要查询截止到2023年3月20号的数据，end_time就传2023-03-20 00:00:00对应的时间戳

start_time必填Int64

开始时间，必须是昨天以前的某个时间戳，最好是传入当天的整点时间戳，例如要查询2023年3月20号以来的数据，start_time就传2023-03-20 00:00:00对应的时间戳

aweme_short_id_listArray<String>

查询的抖音号列表，限制长度在200以内，即一次性最多查询 200个抖音号所对应的自挂载，达人挂载视频所产生的数据

host_nameString

宿主APP，douyin-抖音；douyin_lite-抖音lite；toutiao-今日头条；tt_lite-今日头条lite；huoshan-抖音火山版；不传表示查全部端数据

item_id_listArray<String>

查询的短视频列表，该参数和open_item_id_list参数长度合限制在200以内，即一次性最多查询200个自挂载，达人挂载该小程序的短视频所产生的数据

open_item_id_listArray<String>

查询的加密短视频列表，该参数和item_id_list参数长度合限制在200以内，即一次性最多查询200个自挂载，达人挂载该小程序的短视频所产生的数据

query_bind_typeInt32

查询数据的挂载类型，1-自挂载数据，0-达人挂载+自挂载数据，4-达人挂载+自挂载+通用挂载数据，目前调用此open_api必须传此参数，可以传0或1或4，不要不传，不传可能返回非预期的结果

请求示例
curl --location --request POST 'https://open.douyin.com/api/platform/v2/data_analysis/query_video_data/' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data '{"aweme_short_id_list":[],"item_id_list":[],"open_item_id_list":[],"start_time":5177295280,"end_time":85726091,"host_name":"douyin","query_bind_type":4}'

响应参数

Body展开全部子属性

err_msg必填String

错误信息

err_no必填Int32

错误码

log_id必填String

排查错误的logId

dataStruct

展开子属性

响应示例
正常响应示例异常响应示例
{
  "err_no": 0,
  "err_msg": "success",
  "data": {
      //一段日期范围内产生的总览数据
      "video_deal_overview_data": {
        "video_play_cnt": 6005,    //短视频播放次数
        "mp_show_pv": 5026,        //小程序曝光次数
        "mp_click_pv": 25,         //小程序点击次数
        "create_order_cnt": 0,     //创建订单数
        "pay_order_cnt": 0,        //支付订单数
        "mp_drainage_pv": 0,       //小程序引流次数(视频挂载小程序时，点击小程序入口并成功进入到小程序的次数)
        "mp_drainage_uv": 0,       //小程序引流人数(视频挂载小程序时，点击小程序入口并成功进入到小程序的人数)
        "mp_show_uv":0,            //小程序曝光人数
        "mp_click_uv":0,           //小程序点击人数
        "video_play_user_cnt":2000,//短视频播放人数
        "pay_customer_cnt":0,      //支付订单人数
        "pay_order_amount":0,      //支付订单金额(单位：分)
        "customer_once_price":0,   //客单价(支付订单金额/支付订单人数)(单位：分)
        "order_once_price":0,      //单均价(支付订单金额/支付订单数)(单位：分)
        "refund_customer_cnt":0,   //发起退款人数
        "refund_order_cnt":0,      //发起退款订单数
        "refund_amount":0          //发起退款金额(单位：分)
      },
      //对应日期产生的数据
      "video_deal_data_list": [
        {
          "time": "2023-03-20",      //日期
          "video_play_cnt": 6005,    //短视频播放次数
          "mp_show_pv": 5026,        //小程序曝光次数
          "mp_click_pv": 25,         //小程序点击次数
          "create_order_cnt": 0,     //创建订单数
          "pay_order_cnt": 0,        //支付订单数
          "mp_drainage_pv": 0,       //小程序引流次数(视频挂载小程序时，点击小程序入口并成功进入到小程序的次数)
          "mp_drainage_uv": 0,       //小程序引流人数(视频挂载小程序时，点击小程序入口并成功进入到小程序的人数)
          "mp_show_uv":0,            //小程序曝光人数
          "mp_click_uv":0,           //小程序点击人数
          "video_play_user_cnt":2000,//短视频播放人数
          "pay_customer_cnt":0,      //支付订单人数
          "pay_order_amount":0,      //支付订单金额(单位：分)
          "customer_once_price":0,   //客单价(支付订单金额/支付订单人数)(单位：分)
          "order_once_price":0,      //单均价(支付订单金额/支付订单数)(单位：分)
          "refund_customer_cnt":0,   //发起退款人数
          "refund_order_cnt":0,      //发起退款订单数
          "refund_amount":0          //发起退款金额(单位：分)
        },
        {
          "time": "2023-03-21",      //日期
          "video_play_cnt": 6005,    //短视频播放次数
          "mp_show_pv": 5026,        //小程序曝光次数
          "mp_click_pv": 25,         //小程序点击次数
          "create_order_cnt": 0,     //创建订单数
          "pay_order_cnt": 0,        //支付订单数
          "mp_drainage_pv": 0,       //小程序引流次数(视频挂载小程序时，点击小程序入口并成功进入到小程序的次数)
          "mp_drainage_uv": 0,       //小程序引流人数(视频挂载小程序时，点击小程序入口并成功进入到小程序的人数)
          "mp_show_uv":0,            //小程序曝光人数
          "mp_click_uv":0,           //小程序点击人数
          "video_play_user_cnt":2000,//短视频播放人数
          "pay_customer_cnt":0,      //支付订单人数
          "pay_order_amount":0,      //支付订单金额(单位：分)
          "customer_once_price":0,   //客单价(支付订单金额/支付订单人数)(单位：分)
          "order_once_price":0,      //单均价(支付订单金额/支付订单数)(单位：分)
          "refund_customer_cnt":0,   //发起退款人数
          "refund_order_cnt":0,      //发起退款订单数
          "refund_amount":0          //发起退款金额(单位：分)
        }
      ]
  },
  "log_id":xxx
}

切换单列布局

错误码

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

开发者文档

短视频总览数据

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

短视频总览数据在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

短视频总览数据