接口说明

获取小程序的直播交易分析数据。数据内容与“小程序控制台-数据-数据中心-直播-历史直播/实时直播”页面里的交易数据保持一致。

使用限制

历史直播间：每日 14:00 前更新前一日数据

基本信息

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

Query

live_room_id必填Int64

直播间ID，可通过【获取直播房间数据】接口获取

该字段通过 /api/platform/v2/data_analysis/query_live_room/ 接口返回的 data.history_live_room.0.live_room_id 字段获取

请求示例
curl --location --request GET 'https://open.douyin.com/api/platform/v2/data_analysis/query_live_deal_data/?live_room_id=4065266682059184598' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \

响应参数

Body展开全部子属性

err_msg必填String

错误信息

err_no必填Int32

错误码

log_id必填String

排查错误的logId

dataStruct

展开子属性

响应示例
正常响应示例异常响应示例
{
  "err_no": 0,
  "err_msg": "success",
  "log_id": "xxx",
  "data": {
    "deal_overview_data": {
      "create_user_count": 0,
      "show_count": 0,
      "create_order_count": 0,
      "customer_once_price": 0,
      "pay_order_count": 0,
      "refund_order_amount": 0,
      "sale_product_cnt": 0,
      "click_count": 0,
      "create_order_amount": 0,
      "refund_success_order_cnt": 0,
      "refund_success_user_cnt": 0,
      "success_user_cnt": 0,
      "order_once_price": 0,
      "refund_order_cnt": 0,
      "pay_order_amount": 0,
      "refund_success_order_amount": 0
    },
    "deal_data_list": [
      {
        "time": "2022-12-27 15:04:05",
        "create_user_count": 0,
        "show_count": 0,
        "create_order_count": 0,
        "customer_once_price": 0,
        "pay_order_count": 0,
        "refund_order_amount": 0,
        "sale_product_cnt": 0,
        "click_count": 0,
        "create_order_amount": 0,
        "refund_success_order_cnt": 0,
        "refund_success_user_cnt": 0,
        "success_user_cnt": 0,
        "order_once_price": 0,
        "refund_order_cnt": 0,
        "pay_order_amount": 0,
        "refund_success_order_amount": 0
      }
    ]
  }
}

切换单列布局

错误码

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

直播交易分析在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

直播交易分析