Menu

DescribeTRTCMarketScaleData

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.

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.

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.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeTRTCMarketScaleData.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionNoStringCommon Params. This parameter is not required for this API.
SdkAppIdYesStringUser SDKAppId
StartTimeYesDateQuery 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)
EndTimeYesDateQuery end time, format is YYYY-MM-DD.
PeriodYesStringThe 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.

3. Output Parameters

Parameter NameTypeDescription
DataTRTCDataResultTRTC Data Dashboard output parameters
RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

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.

Command Line Interface

6. Error Code

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