Domain name for API request: trtc.intl.tencentcloudapi.com.
Query TRTC Monitoring Dashboard - Data Dashboard Quality Metrics (including the following metrics)
joinSuccessRate: Join channel success rate.
joinSuccessIn5sRate: Join channel success rate within 5s.
audioFreezeRate: Audio stutter rate.
videoFreezeRate: Video stutter rate.
networkDelay: Lag rate.
Note:
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: DescribeTRTCMarketQualityData. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| SdkAppId | Yes | String | User SdkAppId (for example: 1400xxxxxx). |
| StartTime | Yes | Date | Query start time, and the format is YYYY-MM-DD. (query time range is based on the monitoring dashboard feature version. the basic version supports querying the last 30 days, and the advanced version supports querying the last 60 days). |
| EndTime | Yes | Date | Query end time in YYYY-MM-DD format. |
| Period | Yes | String | The granularity of returned data supports the following values:. d: day. at this time, return the data of UTC time at zero point within a specified time range. h: billed hourly. at this point, return the data of full hour UTC time within a specified time range. |
| IsFloat | No | Boolean | Whether the returned data is a decimal. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | TRTCDataResult | TRTC monitoring data output parameters. Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query TRTC data dashboard quality related data
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCMarketQualityData
<Public request parameters>
{
"SdkAppId": "1400xxxxxx",
"StartTime": "2020-09-22",
"EndTime": "2020-09-22",
"Period": "d"
}
{
"Response": {
"Data": {
"StatementID": 0,
"Series": [
{
"Columns": [
"time",
"videoFreezeRate",
"audioFreezeRate",
"networkDelay",
"joinSuccessRate",
"joinSuccessIn5sRate"
],
"Values": [
{
"RowValue": [
1664553600,
2,
0,
0,
97,
97
]
},
{
"RowValue": [
1664640000,
3,
0,
0,
98,
98
]
}
]
}
],
"Total": 1
},
"RequestId": "4mry45x5sslfsee3vfl5n99oz4u9u-8w"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈