抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • OpenAPI 简介
  • 通用参数
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 支付
  • 运营
  • 解决方案
  • 素材库
  • 数据分析
  • 用户分析
  • 交易分析
  • 短视频分析
  • 直播分析
  • 小房子直播分析
  • 留资分析
  • 组件使用数据
  • 流量来源
  • 组件详细数据
  • 组件使用对比
  • 服务类目
  • 直播间能力
  • 视频关键词管理
  • 能力申请
  • 页面结构自定义
  • 普通二维码绑定
  • 生活服务
  • 垂直行业
  • 其它
  • 组件使用数据

    收藏
    我的收藏

    接口说明

    获取小程序的留资组件配置的使用数据。数据内容可参考“小程序控制台-数据-数据中心-能力-线索组件-组件使用数据”页面

    使用限制

    • 每日 14:00 前更新前一日数据
    • 只能查询昨天以前,且是近90天内的数据

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/api/platform/v2/data_analysis/query_component_with_overview/
    HTTP Method
    POST
    权限要求

    服务商代调用场景下,需商家授予数据分析权限集

    请求参数

    请求头
    access-token必填String
    当非服务商时,调用https://developer.toutiao.com/api/apps/v2/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

    开始时间,必须是昨天以前的某个时间戳

    componentId_listArray<String>

    组件配置id(配置的唯一标识)。可以通过查询已创建的线索组件接口获得。

    请求示例
    curl --location --request POST 'https://open.douyin.com/api/platform/v2/data_analysis/query_component_with_overview/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"start_time":4129985245788524837,"end_time":6136550683620028954,"componentId_list":["3ND5vHMmKz"]}'

    响应参数

    Body展开全部子属性
    err_msg必填String

    错误信息

    err_no必填Int32

    错误码

    log_id必填String

    排查错误的logId

    dataStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "err_no": 0, "log_id": "20240109180849D46806ACB8D19E0802F9", "data": { "ComponentDataInfoList": [ { "ClueUcnt": 0, "ComponentClickUv": 1, "ComponentReportPv": 0, "ComponentReportUv": 0, "ComponentShowPv": 1, "Date": "20231128", "ValidClueCnt": 0, "ClueCnt": 0, "ValidClueUcnt": 0, "ComponentShowUv": 1, "ComponentClickPv": 1 } ], "ComponentOverviewData": { "ValidClueUcnt": 0, "ClueCnt": 0, "ComponentClickPv": 1, "ComponentReportPv": 0, "ComponentReportUv": 0, "ValidClueCnt": 0, "ClueUcnt": 0, "ComponentClickUv": 1, "ComponentShowPv": 1, "ComponentShowUv": 1 } }, "err_msg": "" }
    切换单列布局

    错误码

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