Domain name for API request: trtc.tencentcloudapi.com.
Query TRTC Monitoring Dashboard - Data Dashboard Scale Metrics (will return userCount, roomCount, peakCurrentUsers, peakCurrentChannels)
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: DescribeTRTCMarketScaleData. |
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 |
StartTime | Yes | Date | Query start time, format is YYYY-MM-DD. (The query time range depends on the monitoring dashboard function version, the premium edition can query up to 60 days) |
EndTime | Yes | Date | Query end time, format is YYYY-MM-DD. |
Period | Yes | String | The granularity of the returned data, which can be set to the following values: d: by day. This returns data for the entire UTC day of the query time range. h: by hour. This returns data for the entire UTC hour of the query time range. |
Parameter Name | Type | Description |
---|---|---|
Data | TRTCDataResult | TRTC Data Dashboard output parameters |
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 scale data
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCMarketScaleData
<Public request parameters>
{
"SdkAppId": "1400xxxxxx",
"StartTime": "2023-09-20",
"EndTime": "2023-09-23",
"Period": "d"
}
{
"Response": {
"Data": {
"StatementID": 0,
"Series": [
{
"Columns": [
"time",
"peakCurrentUsers",
"peakCurrentChannels",
"userCount",
"roomCount"
],
"Values": [
{
"RowValue": [
1695139200,
55,
37,
784,
572
]
},
{
"RowValue": [
1695225600,
62,
46,
848,
614
]
},
{
"RowValue": [
1695312000,
47,
45,
950,
695
]
},
{
"RowValue": [
1695398400,
36,
35,
378,
313
]
}
]
}
],
"Total": 1
},
"RequestId": "kp38ibciayx-elqqjdfrf7umkvpbvowt"
}
}
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.
Was this page helpful?