tencent cloud

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

Query TRTC Monitoring Dashboard - Data Dashboard Scale Metrics (will return userCount, roomCount, peakCurrentUsers, peakCurrentChannels)

• userCount: number of users in the call,
• roomCount: number of rooms in the call, counted as one call channel from the time a user joins the channel to the time all users leave the channel.
• peakCurrentChannels: peak number of channels online at the same time.
• peakCurrentUsers: peak number of users online at the same time.
  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: https://trtc.io/document/54481.
2. The query time range depends on the monitoring dashboard function version, premium edition can query up to 60 days.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 DescribeTRTCMarketScaleData

Query TRTC data dashboard scale data

Input Example

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"
}

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.