短视频详细数据
根据短视频 ID 或抖音号获取对应的短视频信息(支持按短视频发布时间筛选,使用 start_time 和 end_time 字段)(支持按宿主端筛选,使用 host_name 字段)。
若使用短视频 ID 查询,则返回对应短视频信息。
若使用抖音号查询,则返回这个抖音号所发布的自挂载,达人挂载短视频信息。
使用限制
- •每日 14:00:00 前更新前一日数据。
- •只能查询昨天以前,且是近90天内的数据。
- •串行调用,控制该open_api的调用频率,并发太高可能触发限流
接口说明
- •业务场景:此open_api仅支持查看自挂载,达人挂载短视频的相关数据(全部挂载数据近期开放,敬请期待)。
- •查询范围限制:UGC挂载数据暂不开放,原因如下:UGC挂载能力下用户的挂载属于自发行为,未经用户授权对经营者开放数据信息涉及数据安全和隐私安全问题,因此暂不对外开放,感谢您的理解。
- •注意事项:此open_api获取的是离线数据,支持查看近90天所发布的短视频详细数据,当天发布的短视频数据无法在当天查看,请在下一天查看。
基本信息
名称 | 描述 |
HTTP URL | |
HTTP Method | POST |
Scope | 无 |
权限要求 | 服务商代调用场景下,需商家授予数据分析权限集 |
请求头
请求参数
名称 | 类型 | 是否必填 | 描述 | 默认值 |
start_time | int64 | 是 | 开始时间,必须是昨天以前的某个时间戳,传入当天的整点时间戳,例如要查询2023年3月20号以来的数据,start_time就传2023-03-20 00:00:00对应的时间戳 | 无 |
end_time | int64 | 是 | 结束时间,必须是昨天以前的某个时间戳,传入当天的整点时间戳,例如要查询截止到2023年3月20号的数据 query_bind_type=0,end_time就传2023-03-20 00:00:00对应的时间戳 query_bind_type=1,end_time就传2023-03-20 23:59:59对应的时间戳 | 无 |
host_name | string | 否 | 宿主APP,douyin-抖音;douyin_lite-抖音lite;toutiao-今日头条;tt_lite-今日头条lite;huoshan-抖音火山版;不传表示查全部端数据 | 无 |
query_bind_type | int64 | 是 | 查询数据的挂载类型,1-自挂载数据,0-自挂载+达人挂载数据,目前调用此open_api必须传0或1。传其他字段会产生非预期的结果 | 1 |
aweme_short_id_list | array | 否 | 查询的抖音号列表,限制长度在200以内,即一次性最多查询 200个抖音号 所对应的自挂载,达人挂载视频/自挂载,达人挂载直播间所产生的数据 | 无 |
query_data_type | int64 | 是 | 查询的列表类型,传4表示查询短视频数据,传5表示查询直播间数据 | 无 |
item_id_list | array | 否 | 查询的短视频列表,该参数和open_item_id_list参数长度合限制在1000以内,即一次性最多查询 1000个 自挂载,达人挂载短视频的详细数据 | 无 |
open_item_id_list | array | 否 | 查询的加密短视频列表,该参数和item_id_list参数长度合限制在1000以内,即一次性最多查询 1000个 自挂载,达人挂载该小程序的短视频所产生的数据 | 无 |
room_id_list | array | 否 | 查询的直播间列表,限制长度在1000以内,即一次性最多查询 1000个 自挂载,达人挂载直播间的详细数据 | 无 |
page_no | int64 | 是 | 查询页号,从1开始 | 无 |
page_size | int64 | 是 | 每页的大小(20以内),分页结果按短视频发布时间or直播间开播时间倒序排列(如果出现系统错误,建议调小分页大小获取) | 无 |
请求示例
//查询"xxx","xxx"这两个抖音号在 2023年3月20日 到 2023年3月21日 在抖音端发布的自挂载,达人挂载短视频详细数据 { "start_time": 1679241600, "end_time": 1679328000, "host_name": "douyin", "query_bind_type": 0, "aweme_short_id_list": ["xxx","xxx"], "query_data_type":4, "page_no":1, "page_size":100 } /**查询"7169582939932","716958217457932"这两个短视频ID中发布时间在 2023年3月20日 到 2023年3月21日 之间的短视频的详细数据**/ { "start_time": 1679241600, "end_time": 1679328000, "query_bind_type": 1, "item_id_list": ["7169582939932","716958217457932"], "open_item_id_list": ["@+mBxX3X5nqAF2xpmBxlSuRAyt+dfQfc7UnuQdDXzWUB9BtjSmH12d3fcFVF++2xOEzYKH+kboOjsmFRO+ahTAQ==", "@+mBxX3X5nqAF2xpmBxlSuRAyt+dfQfc7U32ReT7+UkJ8C4jV3H2wk1C8FVF++2xOkETGWYts5haD9aCpAKVqEQ=="] "query_data_type":4, "page_no":1, "page_size":100 }
响应参数
名称 | 类型 | 是否必填 | 描述 | 默认值 |
err_no | int64 | 是 | 错误码 | |
err_msg | string | 是 | 错误信息 | |
log_id | string | 是 | log_id,用于向内部开发人员进行反馈 | |
data | object | 是 | 响应结果(具体结构见下方正常示例) | |
响应示例
正常示例
{ "err_no":0, "err_msg":"success", "data":{ // 短视频/直播间详细数据列表,每一个元素表示一个短视频/直播间数据,列表按短视频发布时间/直播间开播时间倒序排列 "data_list":[ { //如果是短视频,则会返回如下指标 "item_id": "7169582199207939932", //短视频ID "open_item_id_list": "@+mBxX3X5nqAF2xpmBxlSuRAyt+dfQfc7UnuQdDXzWUB9BtjSmH12d3fcFVF++2xOEzYKH+kboOjsmFRO+ahTAQ==", // 加密视频ID "item_title": "无敌战神", //短视频标题 "item_cover": "xxx", //短视频封面(目前只有抖音端发布的短视频才有封面地址) "item_addr": "xxx", //短视频播放地址(目前只有抖音端发布的短视频才有播放地址) "item_aweme_shortid":"今天又明天", //短视频作者对应的抖音号 "item_aweme_type":"1", //短视频作者对应的类型,1:企业号 0:个人号 "item_aweme_name":"xxx", //短视频作者的昵称 "item_aweme_avatar":"xxx", //短视频作者头像地址 "item_duration":"449", //短视频时长,单位秒 "item_create_time":"1679241689", //短视频创建时间,时间戳形式 "item_last_frame_watch_cnt":2, //短视频最后一帧观看完成次数 "item_completion_rate":"10%", //短视频完播率(短视频最后一帧观看完成次数/短视频播放次数) "item_comment_count":"1", //短视频评论次数 "item_like_count":"1", //短视频点赞次数 "item_share_count":"1", //短视频分享次数 "item_vv":"20", //短视频播放次数 "mp_show_pv":"2", //小程序曝光次数 "mp_click_pv":"2", //小程序点击次数(该指标后续不再提供,可以参考 mp_drainage_pv 指标) "mp_drainage_pv":"2", //进入小程序次数 "item_uv":"20", //短视频播放人数 "mp_show_uv":"2", //小程序曝光人数 "mp_click_uv":"2", //小程序点击人数(该指标后续不再提供,可以参考 mp_drainage_uv 指标) "mp_drainage_uv":"2", //进入小程序人数 "pay_order_cnt":"1", //支付订单数 "pay_customer_cnt":"1", //支付订单人数 "pay_order_amount":"1", //支付订单金额(单位:分) "customer_once_price":"1", //客单价(支付订单金额/支付订单人数 单位:分) "order_once_price":"1", //单均价(支付订单金额/支付订单数 单位:分) "refund_customer_cnt":"0", //发起退款用户数 "refund_order_cnt":"0", //发起退款订单数 "refund_amount":"0" //发起退款金额(单位:分) "bc_relation_bind_type":"0" //BC账号绑定关系,0-普通号,100-品牌号,200-员工号,300-合作号 }, { ... }, { ... } , ... ], "sum":20, //在查询条件范围内发布视频/直播间的总数 // 此字段只有在查询单个直播间时才有数据返回,用于展示跨天直播的直播间在每一天所产生的详细数据,key:每天整点时间戳,value:直播间数据 "detail_data":{ 1679241600:{ //与data_list列表中的元素的字段相同 ... }, 1679328000:{ ... } } }, "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 |