1. API Description
Domain name for API request: trtc.intl.tencentcloudapi.com.
Query TRTC Monitoring Dashboard - Real-Time Monitoring Scale Metrics (the following metrics will be returned) -userCount (Online users) -roomCount (Online rooms) Note: 1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481. 2. The query time range depends on the function version of the monitoring dashboard. The premium edition can query the last 1 hours
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribeTRTCRealTimeScaleData. |
| 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 (e.g., 1400xxxxxx) |
| StartTime |
Yes |
Integer |
Start time, unix timestamp, Unit: seconds (Query time range depends on the function version of the monitoring dashboard, premium edition can query up to 1 hours) |
| EndTime |
Yes |
Integer |
End time, unix timestamp, Unit: seconds |
| RoomId |
No |
String |
Room ID |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Data |
TRTCDataResult |
TRTC Real- Time Monitoring
output parameter |
| 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. |
4. Example
Example1 DescribeTRTCRealTimeScaleData
Query online TRTC rooms and users
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCRealTimeScaleData
<Public request parameters>
{
"StartTime": 1695711343,
"EndTime": 1695711643,
"SdkAppId": "1400xxxxxx"
}
Output Example
{
"Response": {
"Data": {
"StatementID": 0,
"Series": [
{
"Columns": [
"time",
"userCount",
"roomCount"
],
"Values": [
{
"RowValue": [
1695711350,
22,
18
]
},
{
"RowValue": [
1695711360,
22,
18
]
},
{
"RowValue": [
1695711370,
22,
18
]
},
{
"RowValue": [
1695711380,
22,
18
]
},
{
"RowValue": [
1695711390,
23,
18
]
},
{
"RowValue": [
1695711400,
21,
18
]
},
{
"RowValue": [
1695711410,
21,
18
]
},
{
"RowValue": [
1695711420,
21,
18
]
},
{
"RowValue": [
1695711430,
21,
18
]
},
{
"RowValue": [
1695711440,
21,
18
]
},
{
"RowValue": [
1695711450,
21,
18
]
},
{
"RowValue": [
1695711460,
21,
18
]
},
{
"RowValue": [
1695711470,
21,
18
]
},
{
"RowValue": [
1695711480,
21,
18
]
},
{
"RowValue": [
1695711490,
21,
18
]
},
{
"RowValue": [
1695711500,
21,
18
]
},
{
"RowValue": [
1695711510,
21,
18
]
},
{
"RowValue": [
1695711520,
21,
18
]
},
{
"RowValue": [
1695711530,
21,
18
]
},
{
"RowValue": [
1695711540,
21,
18
]
},
{
"RowValue": [
1695711550,
22,
19
]
},
{
"RowValue": [
1695711560,
22,
19
]
},
{
"RowValue": [
1695711570,
22,
19
]
},
{
"RowValue": [
1695711580,
22,
19
]
},
{
"RowValue": [
1695711590,
22,
19
]
},
{
"RowValue": [
1695711600,
22,
19
]
},
{
"RowValue": [
1695711610,
22,
19
]
},
{
"RowValue": [
1695711620,
22,
19
]
},
{
"RowValue": [
1695711630,
24,
20
]
},
{
"RowValue": [
1695711640,
22,
19
]
}
]
}
],
"Total": 1
},
"RequestId": "7gb56tcisiuy9el619p3jjkccop9qpv8"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| UnsupportedOperation |
Unsupported operation. |