实时音视频查询TRTC数据大盘质量相关数据-监控仪表盘查询相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： trtc.tencentcloudapi.com 。

查询TRTC监控仪表盘-数据大盘质量指标（包括下列指标）
joinSuccessRate：加入频道成功率。
joinSuccessIn5sRate：5s内加入频道成功率。
audioFreezeRate：音频卡顿率。
videoFreezeRate：视频卡顿率。
networkDelay ：网络延迟率。
注意：
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明。
2.查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTRTCMarketQualityData。
Version	是	String	公共参数，本接口取值：2019-07-22。
Region	否	String	公共参数，此参数为可选参数。
SdkAppId	是	String	用户SdkAppId（如：1400xxxxxx）示例值：1400188366
StartTime	是	Date	查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）示例值：2022-10-20
EndTime	是	Date	查询结束时间，格式为YYYY-MM-DD。示例值：2022-10-21
Period	是	String	返回数据的粒度，支持设为以下值： d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。 h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。示例值："d"

3. 输出参数

参数名称	类型	描述
Data	TRTCDataResult	TRTC监控数据出参注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeTRTCMarketQualityData

查询TRTC数据大盘质量相关数据

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCMarketQualityData
<公共请求参数>

{
    "SdkAppId": "1400xxxxxx",
    "StartTime": "2020-09-22",
    "EndTime": "2020-09-22",
    "Period": "d"
}

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。