Overview
Features
Use Cases
Domain name for API request: rum.intl.tencentcloudapi.com.
This API is used to get the PerformancePage information.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDataPerformancePage. |
| Version | Yes | String | Common Params. The value used for this API: 2021-06-22. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| ID | Yes | Integer | Project ID |
| StartTime | Yes | Integer | Start time |
| EndTime | Yes | Integer | End time |
| Type | Yes | String | pagepv: PV view; allcount: performance view; falls: page loading waterfall plot; samp: FMP, day: 14-day data, nettype: network/platform view; performance: top underperformed pages view; version/platform/isp/region/device/browser/ext1/ext2/ext3/ret/status/from/url/env: version view; device view; ISP view; region view; browser view, and so on. |
| Level | No | String | Log level |
| Isp | No | String | ISP |
| Area | No | String | Region |
| NetType | No | String | Network type |
| Platform | No | String | Platform |
| Device | No | String | Model |
| VersionNum | No | String | Version |
| ExtFirst | No | String | Custom 1 |
| ExtSecond | No | String | Custom 2 |
| ExtThird | No | String | Custom 3 |
| IsAbroad | No | String | Whether it is outside the Chinese mainland |
| Browser | No | String | Browser |
| Os | No | String | OS |
| Engine | No | String | Browser engine |
| Brand | No | String | Brand |
| From | No | String | Source page |
| CostType | No | String | Duration calculation method |
| Env | No | String | Environment variable |
| NetStatus | No | String | Network status |
| Parameter Name | Type | Description |
|---|---|---|
| Result | String | Returned value |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
PerformancePage informationPOST / HTTP/1.1
Host: rum.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataPerformancePage
<Common request parameters>
{
"ExtSecond": "Custom 2",
"Engine": "ie2",
"IsAbroad": "1",
"Area": "China",
"NetType": "2",
"Level": "1",
"Os": "apple",
"Brand": "apple",
"Isp": "China Mobile",
"VersionNum": "Version",
"Platform": "2",
"ExtThird": "Custom 3",
"ExtFirst": "Custom 1",
"StartTime": "1625444040",
"Device": "Samsung",
"From": "index.html",
"EndTime": "1625454840",
"Type": "pagepv",
"ID": "1",
"Browser": "ie"
}{
"Response": {
"Result": "xxxx",
"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"
}
}POST / HTTP/1.1
Host: rum.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataPerformancePage
<Common request parameters>
{
"EndTime": "1658390700",
"Type": "allcount",
"ID": "1",
"StartTime": "1658304300"
}{
"Response": {
"RequestId": "ddec0dc8-3268-4571-9ac0-566ae7537495",
"Result": "{\"request_id\":\"ddec0dc8-3268-4571-9ac0-566ae7537495\",\"results\":[{\"statement_id\":0,\"total\":0},{\"statement_id\":1,\"total\":0},{\"statement_id\":2,\"total\":0},{\"statement_id\":3,\"total\":0}]}"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | Error with CAM signature/authentication. |
| DryRunOperation | DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used. |
| FailedOperation | Operation failed. |
| FailedOperation.ClsCallFail | CLS call failed. |
| FailedOperation.DataBaseException | Exceptional data operation. |
| FailedOperation.InfrastructureError | Exceptional third-party dependency. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Missing parameter. |
| OperationDenied | The operation was denied. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is in use. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.NoInstance | The instance does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback