流量来源
接口说明
获取小程序的短视频-流量来源分析数据。数据内容与“小程序控制台-数据-数据中心-短视频-流量来源”模块保持一致。
使用限制
- 每日 14:00 前更新前一日数据
- 只能查询昨天以前,且是近90天内的数据
- 串行调用,控制该open_api的调用频率,并发太高可能触发限流
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/platform/v2/data_analysis/query_video_with_source/ |
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
当服务商时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
content-type必填String
示例:application/json
固定值"application/json"
Body
end_time必填Int64
结束时间,必须是昨天以前的某个时间戳
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_video_with_source/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"start_time":268677957895199601,"end_time":1550656589714520118,"host_name":"bwVY0ZzgtM","aweme_short_id_list":["YsJYkhFIGF"]}'
响应参数
Body展开全部子属性
err_msg必填String
错误信息
err_no必填Int32
错误码
log_id必填String
排查错误的logId
dataStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "DataList": [ { "CommonData": { "MpDrainagePv": 0, "MpDrainageUv": 0, "MpShowPv": 34, "MpShowUv": 13 }, "Scenes": "homepage_follow", "ScenesName": "关注页", "VideoPlayCount": 0 }, { "CommonData": { "MpDrainagePv": 0, "MpDrainageUv": 0, "MpShowPv": 20, "MpShowUv": 13 }, "Scenes": "others_homepage", "ScenesName": "他人主页", "VideoPlayCount": 0 }, { "CommonData": { "MpDrainagePv": 0, "MpDrainageUv": 0, "MpShowPv": 1, "MpShowUv": 1 }, "Scenes": "homepage_fresh", "ScenesName": "同城页", "VideoPlayCount": 0 }, { "CommonData": { "MpDrainagePv": 0, "MpDrainageUv": 0, "MpShowPv": 5, "MpShowUv": 5 }, "Scenes": "general_search", "ScenesName": "综搜页", "VideoPlayCount": 0 }, { "CommonData": { "MpDrainagePv": 15, "MpDrainageUv": 5, "MpShowPv": 331, "MpShowUv": 325 }, "Scenes": "homepage_hot", "ScenesName": "推荐页", "VideoPlayCount": 0 }, { "CommonData": { "MpDrainagePv": 86, "MpDrainageUv": 19, "MpShowPv": 377, "MpShowUv": 352 }, "Scenes": "other", "ScenesName": "其它", "VideoPlayCount": 0 } ] }, "err_msg": "success", "err_no": 0, "log_id": "xxx" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | -1 | 系统错误 | 建议重试,若多次重试失败,可向平台反馈该问题 |
200 | 11009 | 参数不合法或缺少参数 | 检查参数合法性,注意参数类型以及是否缺少必要参数 |
200 | 28001003 | access_token无效 | 请检查access_token |
200 | 28001007 | 必填字段缺失 | 请检查必填字段 |
200 | 28001008 | access_token过期 | 请刷新或重新授权access_token |