前端性能监控查询 app 多维分析数据

1. 接口描述

接口请求域名： rum.tencentcloudapi.com 。

用于查询 app 监控多维分析数据

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAppDimensionMetrics。
Version	是	String	公共参数，本接口取值：2021-06-22。
Region	否	String	公共参数，此参数为可选参数。
ProjectID	是	Integer	app 项目ID 示例值：1
From	是	String	查询的表名示例值：kv_7_dist
Fields	是	String	查询指标 fields 示例值："[["as","device_id","device_id"],"entrance_time",["as","feature_md5","feature_md5"],["as","version","version"],["as","id","id"],["as","user_id","user_id"]]"
Filter	是	String	查询的过滤条件示例值："{"category__in":["PERF_CRASH"]}"
FilterSimple	否	String	查询简单过滤条件示例值：{"category__in":["PERF_CRASH","APP_LAUNCH"]}
GroupBy.N	否	Array of String	group by 条件示例值：["request_cnt"]
OrderBy.N	否	Array of String	order by 条件示例值：["request_cnt desc"]
Limit	否	Integer	limit 参数示例值：1
Offset	否	Integer	offset 参数示例值：1
BusinessContext	否	String	业务上下文参数示例值：{"threshold":"0.001"}

3. 输出参数

参数名称	类型	描述
Data	String	查询数据返回示例值：{"status":"ok","code":10000,"msg":"ok","data":[]}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询多维分析数据

输入示例

POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAppDimensionMetrics
<公共请求参数>

{
    "Filter": "'[]'",
    "ProjectID": 1,
    "FilterSimple": "'{\\\"entrance_time__gte\\\":1671367462000,\\\"entrance_time__lte\\\":1671453862000,\\\"category__in\\\":[\\\"PERF_NET_REQUEST\\\"],\\\"d4\\\":\\\"false\\\",\\\"d3\\\":\\\"http\\\",\\\"v1__lte\\\":300000}'",
    "From": "'kv_7_dist'",
    "Fields": "'[[\\\"explodeDimensions\\\",\\\"d2\\\",\\\"d8\\\"],[\\\"as\\\",[\\\"multiIf\\\",[\\\"equals\\\",\\\"dimension_name\\\",\\\"'d2'\\\"],\\\"'domain'\\\",[\\\"equals\\\",\\\"dimension_name\\\",\\\"'d8'\\\"],\\\"'region'\\\",\\\"dimension_name\\\"],\\\"dimension\\\"],[\\\"as\\\",[\\\"avg\\\",\\\"v1\\\"],\\\"cost_time\\\"],[\\\"as\\\",[\\\"count\\\",1],\\\"request_cnt\\\"],[\\\"as\\\",[\\\"aggByPartition\\\",\\\"sum\\\",\\\"request_cnt\\\",\\\"dimension_name\\\"],\\\"total_request_cnt\\\"],[\\\"as\\\",\\\"total_request_cnt\\\",\\\"total_cnt\\\"],[\\\"as\\\",\\\"request_cnt\\\",\\\"cnt\\\"],[\\\"as\\\",[\\\"aggByPartition\\\",\\\"row_number\\\",\\\"none\\\",\\\"dimension_name\\\",[\\\"order_by\\\",\\\"request_cnt\\\",\\\"desc\\\"]],\\\"rank_cnt\\\"]]'",
    "Limit": 1000
}

输出示例

{
    "Response": {
        "Data": "'{\"status\":\"ok\",\"code\":10000,\"msg\":\"ok\",\"data\":[{\"by_dimension\":[\"d2\",\"m.zipkin.com\"],\"cnt\":1280,\"cost_time\":1480,\"dimension\":\"domain\",\"dimension_name\":\"d2\",\"dimension_value\":\"m.zipkin.com\",\"rank_cnt\":1,\"request_cnt\":1280,\"total_cnt\":1280,\"total_request_cnt\":1280},{\"by_dimension\":[\"d8\",\"unsupported\"],\"cnt\":1280,\"cost_time\":1480,\"dimension\":\"region\",\"dimension_name\":\"d8\",\"dimension_value\":\"unsupported\",\"rank_cnt\":1,\"request_cnt\":1280,\"total_cnt\":1280,\"total_request_cnt\":1280}]}'",
        "RequestId": "8a211fc4-7ce2-40ce-ad49-1c29cca2f3fc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
ResourceNotFound	资源不存在。

查询 app 多维分析数据

本页目录：