1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
会话时间线 / 页面子事件 / 错误前轨迹。Mode:timeline / page / breadcrumb。Limit 默认 200,上限 200。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTDEMRelatedEvents。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用 ID(必填) 示例值:11 |
| StartTime | 是 | Integer | 开始时间 Unix 毫秒(必填,用于分区裁剪) 示例值:1787404860000 |
| EndTime | 是 | Integer | 结束时间 Unix 毫秒(必填) 示例值:1789996860000 |
| Mode | 是 | String | 模式:timeline / page / breadcrumb(必填) 示例值:timeline |
| SessionId | 是 | String | 会话 ID(必填) 示例值:mp_81069b302d52d8396753e1c442276bfd |
| PageUrl | 否 | String | 页面 URL(Mode=page 必填) 示例值:http://localhost:3000 |
| AnchorTimestamp | 否 | Integer | 锚点 Unix 毫秒(Mode=page/breadcrumb 使用) 示例值:1789907696391 |
| Offset | 否 | Integer | 偏移,>=0,默认 0 示例值:0 |
| Limit | 否 | Integer | 条数,1-200,默认 200 示例值:200 |
| Category | 否 | String | 事件分类(可选) 示例值:all |
| Keyword | 否 | String | 关键字(可选) 示例值:搜索 |
| ViewId | 否 | String | 视图 ID 示例值:cdfe32db9b394f0d8040ad3fea1ccdee |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Events | Array of ExplorationEventItem | 关联事件,schema 与 Search 列表项相同 |
| Offset | Integer | 偏移 示例值:0 |
| Limit | Integer | 条数 示例值:200 |
| HasMore | Boolean | 是否还有下一页 示例值:false |
| CategoryCounts | Array of IntKeyValue | 各分类计数,Key 为分类 id 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询相关事件
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTDEMRelatedEvents
<公共请求参数>
{
"AppId": "11",
"StartTime": 1787404860000,
"EndTime": 1789996860000,
"Mode": "timeline",
"SessionId": "mp_81069b302d52d8396753e1c442276bfd",
"Offset": 0,
"Limit": 200,
"Category": "all"
}
输出示例
{
"Response": {
"CategoryCounts": [
{
"Key": "all",
"Value": 147
}
],
"Events": [
{
"AppVersion": "1.0.0",
"Browser": "Safari",
"City": "深圳",
"Country": "中国",
"DeviceType": "mobile",
"EventCategory": "custom",
"EventId": "evt_1789718558702_n1402f",
"EventName": "set_data_timing",
"EventType": "custom",
"Ip": "59.37.125.48",
"Isp": "电信",
"Measurements": [
{
"Key": "duration",
"Value": 36
}
],
"NormalizedPageUrl": "pages/home/home",
"Os": "iPhone OS",
"PageUrl": "pages/home/home",
"Platform": "miniprogram",
"Province": "广东",
"SessionId": "mp_81069b302d52d8396753e1c442276bfd",
"Timestamp": 1789718558702,
"UserId": "tdesigndemo"
}
],
"HasMore": false,
"Limit": 200,
"Offset": 0,
"RequestId": "bd646822-8130-4d52-85df-31ba0fdc1ace"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未CAM授权 |
| FailedOperation | 操作失败。 |
| FailedOperation.DataBaseException | 数据操作异常 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |