1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
获取DescribeDataWebVitalsPage信息,用户核心活动信息
页面加载性能之Web Vitals。性能关键点
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDataWebVitalsPage。 |
Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartTime | 是 | Integer | 开始时间 示例值:1625444040 |
EndTime | 是 | Integer | 结束时间 示例值:1625454840 |
ID | 是 | Integer | 项目ID 示例值:1 |
ExtSecond | 否 | String | 自定义2 示例值:abc |
Engine | 否 | String | 浏览器引擎 示例值:ie7 |
Isp | 否 | String | 运营商 示例值:中国移动 |
From | 否 | String | 来源页面 示例值:index.html |
Level | 否 | String | 日志等级 示例值:1 |
Type | 否 | String | 类型暂无 示例值:pagepv |
Brand | 否 | String | 品牌 示例值:苹果 |
Area | 否 | String | 地区 示例值:中国 |
VersionNum | 否 | String | 版本 示例值:1.2.1 |
Platform | 否 | String | 平台 示例值:2 |
ExtThird | 否 | String | 自定义3 示例值:abc |
ExtFirst | 否 | String | 自定义1 示例值:abc |
NetType | 否 | String | 网络类型 示例值:2 |
Device | 否 | String | 机型 示例值:三星 |
IsAbroad | 否 | String | 显示是否海外,1表示海外,0表示非海外;默认值为空,查询所有。 示例值:1 |
Os | 否 | String | 操作系统 示例值:ios |
Browser | 否 | String | 浏览器 示例值:ie |
CostType | 否 | String | 耗时计算 示例值:avg |
Env | 否 | String | 环境 示例值:prod |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | String | 返回值 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取WebVitalsPage信息
输入示例
https://rum.tencentcloudapi.com/?Action=DescribeDataWebVitalsPage
&ID=1
&StartTime=1625444040
&EndTime=1625454840
&Type=pagepv
&Level=1
&Isp=中国移动
&Area=中国
&NetType=2
&Platform=2
&Device=三星
&VersionNum=版本
&ExtFirst=自定义1
&ExtSecond=自定义2
&ExtThird=自定义3
&IsAbroad=1
&Browser=ie
&Os=apple
&Engine=ie2
&Brand=apple
&From=index.html
&<公共请求参数>
输出示例
{
"Response": {
"Result": "xxxx",
"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.ClsCallFail | CLS调用失败 |
FailedOperation.DataBaseException | 数据操作异常 |
FailedOperation.InfrastructureError | 第三方依赖异常。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.NoInstance | 实例不存在 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |