Docs Overview/
RTC Engine/
Server Features & APIs/
Server APIs/
Monitoring Dashboard APIs/
DescribeTRTCMarketQualityData/

DescribeTRTCMarketQualityData

1. API Description

Domain name for API request: trtc.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:

  1. To call the API, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. 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 the last 30 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: DescribeTRTCMarketQualityData.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionNoStringCommon Params. This parameter is not required for this API.
SdkAppIdYesStringUser SDKAppId (e.g., 1400xxxxxx)
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 30 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, 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 DescribeTRTCMarketQualityData

Query TRTC data dashboard quality related data

Input Example

POST / HTTP/1.1
Host: trtc.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"
}

Output Example

{
    "Response": {
        "Data": {
            "StatementID": 0,
            "Series": [
                {
                    "Columns": [
                        "time",
                        "videoFreezeRate",
                        "audioFreezeRate",
                        "networkDelay",
                        "joinSuccessRate",
                        "joinSuccessRate"
                    ],
                    "Values": [
                        {
                            "RowValue": [
                                1664553600,
                                2,
                                0,
                                0,
                                97,
                                97
                            ]
                        },
                        {
                            "RowValue": [
                                1664640000,
                                3,
                                0,
                                0,
                                98,
                                98
                            ]
                        }
                    ]
                }
            ],
            "Total": 1
        },
        "RequestId": "4mry45x5sslfsee3vfl5n99oz4u9u-8w"
    }
}

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.