You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/标签体系/根据标签id获取标签历史计算结果 - GetHistoryData
根据标签id获取标签历史计算结果 - GetHistoryData
最近更新时间：2024.12.06 13:08:24首次发布时间：2024.07.12 14:50:46
我的收藏

请求说明

  • 请求方式：GET
  • 接口名称：GetHistoryData
  • 请求地址：https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

是

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

X-Tenant

Int

是

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

GetHistoryData

固定值，对应“请求说明”中的“接口名称”

ApiVersion

String

是

2023-06-20

固定值，版本号： 2023-06-20

id

Int

是

1

标签id

period

string

否

周期

showNum

Int

是

标签值数量

startDate

String

是

开始日期

endDate

String

是

结束日期

Body

无

返回参数

下表仅列出返回参数中data字段内容。

参数

类型

示例值

描述

scheduleTime

String

2023-04-20

调度运行时间

distinctNumber

Int

0

标签累计覆盖人数（去重）

coverage

String

0.00%

当前标签覆盖总人数占整个项目覆盖总人数比例 (distinctNumber/mautagDistinctNumber)*100%

statistics

Array

[
                    {
                    "count":0,
                    "originValue":"标签值1",
                    "mappingValue":"标签值1",
                    "tagCoverage":"NA",
                    "totalCoverage":"0.00%"
                    }
            ]

标签枚举值统计列表

statistics.count

Int

0

单个标签值的用户数

statistics.originValue

String

标签值1

当前标签枚举值原始值

statistics.mappingValue

String

标签值1

当前标签枚举值映射值，如果未做映射则等于原始值

statistics.tagCoverage

String

NA

当前标签枚举值映射值覆盖人数占当前标签总覆盖人数的比例

statistics.totalCoverage

String

0.00%

当前标签枚举值映射值覆盖人数占当前项目总覆盖人数的比例

queryMauCost

Int

15

查询服务耗时毫秒数-mau查询部分耗时(类型为mau时恒为0)

queryDataCost

Int

148

查询服务耗时毫秒数-查询部分耗时(包含mau查询的总耗时)

请求示例

{
    "id": 1,
    "showNum": 100,
    "startDate": "2024-11-26",
    "endDate": "2024-12-03"
}

返回示例

{
    "code":0,
    "msg":"成功",
    "data":[
        {
            "scheduleTime":"2023-04-20",
            "distinctNumber":0,
            "coverage":"0.00%",
            "statistics":[
                {
                    "count":0,
                    "originValue":"标签值1",
                    "mappingValue":"标签值1",
                    "tagCoverage":"NA",
                    "totalCoverage":"0.00%"
                }
            ],
            "queryMauCost":15,
            "queryDataCost":148
        },
        {
            "scheduleTime":"2023-04-23",
            "distinctNumber":5124,
            "coverage":"100.00%",
            "statistics":[
                {
                    "count":5124,
                    "originValue":"标签值1",
                    "mappingValue":"标签值1",
                    "tagCoverage":"100.00%",
                    "totalCoverage":"100.00%"
                }
            ],
            "queryMauCost":15,
            "queryDataCost":148
        }
    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。