1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
查询会话列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSessionList。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用id 示例值:2 |
| StartTime | 是 | Integer | 开始时间 单位:毫秒 示例值:1776403015595 |
| EndTime | 是 | Integer | 结束时间 单位:毫秒 示例值:1776417415595 |
| SessionType | 否 | String | session类型 枚举值:
示例值:all |
| Page | 否 | Integer | 页面号 默认值:1 示例值:1 |
| PageSize | 否 | Integer | 每一页的数量 示例值:20 |
| SortBy | 否 | String | 排序字段 示例值:duration |
| SortOrder | 否 | String | 排序方式,ASC或DESC 示例值:DESC |
| UserId | 否 | String | 用户id 示例值:smith |
| SessionId | 否 | String | session id 示例值:1231414 |
| DeviceTypes.N | 否 | Array of String | 设备类型 示例值:["桌面端"] |
| Browsers.N | 否 | Array of String | 浏览器 示例值:["Chrome"] |
| OSList.N | 否 | Array of String | 操作系统 示例值:["Windows"] |
| Platforms.N | 否 | Array of String | 平台 示例值:["web"] |
| AppVersions.N | 否 | Array of String | 应用版本 示例值:["1.0.0"] |
| Countries.N | 否 | Array of String | 国家 示例值:["中国"] |
| HasStruggle | 否 | Boolean | 是否有挣扎事件 示例值:false |
| StruggleRanks.N | 否 | Array of String | 挣扎等级 示例值:["excellent"] |
| StruggleTypes.N | 否 | Array of String | 挣扎事件类型 示例值:["rage_click"] |
| HasError | 否 | Boolean | 是否有错误 示例值:true |
| VisitedPage | 否 | String | 访问页面 示例值:/honme |
| ContainsEvent | 否 | String | 包含事件 示例值:click |
| MinDuration | 否 | Integer | 最小持续时间 示例值:10 |
| MaxDuration | 否 | Integer | 最大持续时间 示例值:10000 |
| PerfFilter | 否 | String | 性能过滤 示例值:all |
| Regions.N | 否 | Array of String | 地区 示例值:["广东"] |
| Environments.N | 否 | Array of String | 环境 示例值:["production"] |
| Filters | 否 | String | 筛选 示例值:[{"Key":"session_id","Op":"in","Values":["1f435dedeb724fa4bdbd5c8b604d044f"]}] |
| StartPage | 否 | String | 旅程起点页面。可选。不传表示不过滤。 示例值:/ |
| EndPage | 否 | String | 旅程终点页面。可选。不传表示不过滤。 示例值:/ |
| JourneyFilters | 否 | String | 旅程筛选条件 JSON 字符串,格式与 Filters 相同:[{Key,Op,Values}]。可选。不传表示不过滤。 示例值:[{"Key": "os", "Op": "eq", "Values": ["Android"]}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 返回结果 示例值:{"Page":1,"PageSize":20,"Sessions":[],"Total":0} |
| ErrorMsg | String | 错误信息 示例值:{"Code":"InvalidParameter","Message":"无效的排序字段"} |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeSessionList
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSessionList
<公共请求参数>
{
"AppId": "146662",
"StartTime": 1776403015595,
"EndTime": 1776417415595,
"SessionType": "all",
"Page": 1,
"PageSize": 20,
"AppVersions": [
"1.0.0"
]
}
输出示例
{
"Response": {
"Result": "{\"Page\":1,\"PageSize\":20,\"Sessions\":[{\"SessionId\":\"c5116f619aba47d2b224a861297a06a9\",\"UserId\":\"700001860566\",\"StartTime\":1776415224792,\"EndTime\":1776417510956,\"Duration\":2286164,\"EventCount\":319,\"ErrorCount\":86,\"HasError\":true,\"PageCount\":34,\"FirstPageUrl\":\"https://console.cloud.tencent.com/monitor/rum/dem-config\",\"DeviceType\":\"desktop\",\"Platform\":\"web\",\"AppVersion\":\"1.0.0\",\"Os\":\"macOS\",\"Browser\":\"Chrome\",\"Country\":\"中国\",\"Region\":\"广东\",\"StruggleScore\":1.0099667774086378,\"StruggleRank\":\"Good\",\"StruggleCount\":18,\"Lcp\":7899,\"Inp\":77.33333333333333,\"Cls\":0.5419550882850751,\"LatestReplayId\":\"rep_40a4ed58d205567aeec2df89dba832d4\"},{\"SessionId\":\"d6db9fe86ef34d6aaf399673626947b5\",\"UserId\":\"700001860566\",\"StartTime\":1776414983628,\"EndTime\":1776415187481,\"Duration\":203853,\"EventCount\":58,\"ErrorCount\":12,\"HasError\":true,\"PageCount\":8,\"FirstPageUrl\":\"https://console.cloud.tencent.com/monitor/rum\",\"DeviceType\":\"desktop\",\"Platform\":\"web\",\"AppVersion\":\"1.0.0\",\"Os\":\"macOS\",\"Browser\":\"Chrome\",\"Country\":\"中国\",\"Region\":\"广东\",\"StruggleScore\":1.3333333333333333,\"StruggleRank\":\"Good\",\"StruggleCount\":4,\"Lcp\":4464,\"Inp\":248,\"Cls\":0.08204904981830531,\"LatestReplayId\":\"rep_92d583b03c8c0e6d0c9dedf2cabfe551\"},{\"SessionId\":\"f1f1a7c657ce4435b64652a8cf4f7589\",\"UserId\":\"700001860566\",\"StartTime\":1776414526253,\"EndTime\":1776415153800,\"Duration\":627547,\"EventCount\":45,\"ErrorCount\":10,\"HasError\":true,\"PageCount\":12,\"FirstPageUrl\":\"https://console.cloud.tencent.com/monitor/rum/session\",\"DeviceType\":\"desktop\",\"Platform\":\"web\",\"AppVersion\":\"1.0.0\",\"Os\":\"Mac OS X\",\"Browser\":\"Electron\",\"Country\":\"中国\",\"Region\":\"广东\",\"StruggleScore\":2.3,\"StruggleRank\":\"Fair\",\"StruggleCount\":5,\"Lcp\":9269.5,\"Inp\":112,\"Cls\":0.18938273533709518,\"LatestReplayId\":\"rep_d60d0e616614f42122f8b95ed04b4d7b\"},{\"SessionId\":\"3bb07f568f3c4e56bfb857a16faaa072\",\"UserId\":\"700001860566\",\"StartTime\":1776413382865,\"EndTime\":1776414511785,\"Duration\":1128920,\"EventCount\":70,\"ErrorCount\":21,\"HasError\":true,\"PageCount\":12,\"FirstPageUrl\":\"https://console.cloud.tencent.com/monitor/rum\",\"DeviceType\":\"desktop\",\"Platform\":\"web\",\"AppVersion\":\"1.0.0\",\"Os\":\"Mac OS X\",\"Browser\":\"Electron\",\"Country\":\"中国\",\"Region\":\"广东\",\"StruggleScore\":1.9682539682539681,\"StruggleRank\":\"Fair\",\"StruggleCount\":7,\"Lcp\":8452.649999976158,\"Inp\":8,\"Cls\":0.40992709039594166,\"LatestReplayId\":\"rep_baacc4b1ac519ae6bc922270462fa9a8\"}],\"Total\":4}",
"RequestId": "3e5887b4-cf01-4958-a8d7-42146dc4690b"
}
}
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授权 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ChargeNoBalance | 计费相关 - 账户余额不足。 |
| FailedOperation.ChargeNoPayRight | 计费相关 - 账户没有付费权限。 |
| FailedOperation.ChargeParamInvalid | 计费相关 - 计费参数无效。 |
| FailedOperation.ClsCallFail | CLS调用失败 |
| FailedOperation.DataBaseException | 数据操作异常 |
| FailedOperation.InfrastructureError | 第三方依赖异常。 |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.NoInstance | 实例不存在 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |