前端性能监控查询探索事件汇总

1. 接口描述

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

同一筛选下的分类计数、访问用户、业务用户、窗口合计与分桶趋势。Category 可含 session。空窗返回 0 与空 Series。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTDEMEventSearchSummary。
Version	是	String	公共参数，本接口取值：2021-06-22。
Region	否	String	公共参数，此参数为可选参数。
AppId	是	String	应用 ID（必填）示例值：11
StartTime	是	Integer	开始时间 Unix 毫秒（必填）示例值：1787404860000
EndTime	是	Integer	结束时间 Unix 毫秒（必填）示例值：1789996860000
Category	是	String	事件分类（必填，可含 session）示例值：error
Filters	否	String	筛选条件 JSON 字符串：[{Key,Op,Values}] 示例值：[{"Key":"app_version","Op":"in","Values":["1.7.0"]},{"Key":"os","Op":"in","Values":["Mac OS X"]},{"Key":"device_type","Op":"in","Values":["Mac"]},{"Key":"resource_url","Op":"in","Values":["xxx"]}]
IntervalSec	否	Integer	分桶秒数，正整数；缺省由服务端按窗口选取示例值：5
HasError	否	Boolean	是否只看有错误的会话。可选。不传表示不过滤。Category 为 session 的汇总查询会使用该条件。示例值：false
MinDuration	否	Integer	会话最短时长，单位毫秒。可选。0 或不传表示不限制。Category 为 session 的汇总查询会使用该条件。示例值：0
MaxDuration	否	Integer	会话最长时长，单位毫秒。可选。0 或不传表示不限制。Category 为 session 的汇总查询会使用该条件。示例值：0

3. 输出参数

参数名称	类型	描述
CategoryCounts	Array of IntKeyValue	各分类窗口计数，Key 为分类 id
Total	Integer	当前分类窗口条数示例值：5
Visitors	Integer	访问用户（设备）示例值：1
Users	Integer	业务用户示例值：1
IntervalSec	Integer	实际分桶秒数示例值：3600
Series	Array of EventSearchSeriesPoint	分桶趋势
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询探索事件汇总

输入示例

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

{
    "AppId": "11",
    "StartTime": 1787404860000,
    "EndTime": 1789996860000,
    "Category": "error"
}

输出示例

{
    "Response": {
        "CategoryCounts": [
            {
                "Key": "session",
                "Value": 1
            }
        ],
        "IntervalSec": 3600,
        "Series": [
            {
                "Count": 5,
                "Timestamp": 1789718400000
            }
        ],
        "Total": 5,
        "Users": 1,
        "Visitors": 1,
        "RequestId": "12301d55-901b-42b4-9755-a261e934477d"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation	请求未CAM授权
FailedOperation	操作失败。
FailedOperation.DataBaseException	数据操作异常
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterCombination	无效参数组合
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceInUse	资源被占用。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。

查询探索事件汇总

本页目录：