小房子直播间详细数据
接口说明
获取挂载对应小程序且模式为小房子类型的直播间在一段时间范围内产生的按直播间 id 维度聚合的交易数据,仅统计有产生交易的直播间。
- 业务场景:当前此open_api仅支持查看直播自挂载小程序且模式为小房子的相关数据(官号&达人直播挂载数据均可获取)。
- 注意事项:该open_api获取的是离线数据,支持查看近180天的相关交易数据,不支持查看当天的数据,当天的数据可以在下一天查看,请严格控制该open_api的调用频率,该接口同一小程序查询限流5QPS.
使用限制
- 每日 14:00 前更新前一日数据
- 只能查询昨天以前,且是近180天内的数据
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/platform/v2/data_analysis/query_small_home_room_data/ |
HTTP Method | GET |
权限要求 | 服务商代调用场景下,需商家授予数据分析权限集 |
请求参数
请求头
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
Query
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对应的时间戳
请求示例
curl --location --request GET 'https://open.douyin.com/api/platform/v2/data_analysis/query_small_home_room_data/?start_time=2102475&end_time=6233429043' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
err_msg必填String
错误信息
err_no必填Int32
错误码
log_id必填String
排查错误的logId
dataStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "app_id": "ttxxxfffffffff", "app_name": "小程序名称", "room_data": { "1001": { "anchor_id": "12345", "app_id": "ttxxxfffffffff", "app_name": "小程序名称", "delivery_success_amount": "50", "delivery_success_order_cnt": "60", "end_time": "1672900091", "live_duration": "6000", "max_watch_user_cnt": "2", "nick_name": "主播nick_name", "pay_amount": "10", "pay_order_cnt": "20", "per_watch_duration": "10", "refund_success_amount": "30", "refund_success_order_cnt": "40", "start_time": "1672900091", "watch_user_cnt": "100000" }, "1002": { "anchor_id": "12345", "app_id": "ttxxxfffffffff", "app_name": "小程序名称", "delivery_success_amount": "50", "delivery_success_order_cnt": "60", "end_time": "1672900091", "live_duration": "6000", "max_watch_user_cnt": "3", "nick_name": "我测试的", "pay_amount": "10", "pay_order_cnt": "20", "per_watch_duration": "10", "refund_success_amount": "30", "refund_success_order_cnt": "40", "start_time": "1672900091", "watch_user_cnt": "100000" } }, "total_num": 2, "has_more": false }, "err_msg": "success", "err_no": 0, "log_id": "xxxxxx" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | -1 | 系统错误 | 建议重试,若多次重试失败,可向平台反馈该问题 |
200 | 11009 | 参数不合法或缺少参数 | 检查参数合法性,注意参数类型以及是否缺少必要参数 |
200 | 50001 | 操作太频繁,请稍后重试 | 触发限流机制,请稍后重试 |
200 | 28001003 | access_token无效 | 请检查access_token |
200 | 28001007 | 必填字段缺失 | 请检查必填字段 |
200 | 28001008 | access_token过期 | 请刷新或重新授权access_token |