1. 接口描述
接口请求域名： trtc.tencentcloudapi.com 。
查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数）
userCount：通话人数，
roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。
peakCurrentChannels：峰值同时在线频道数。
peakCurrentUsers：峰值同时在线人数。
注意：
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTRTCMarketScaleMetricData。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-22。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SdkAppId | 是 | String | 用户SdkAppId 示例值："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 | TRTCDataResp | TRTC监控数据出参 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeTRTCMarketScaleMetricData
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCMarketScaleMetricData
<公共请求参数>
{
"StartTime": "2022-10-01",
"EndTime": "2022-10-13",
"Period": "d",
"SdkAppId": "1400188366"
}输出示例
{
"Response": {
"Data": {
"StatementID": 0,
"Series": [
{
"Columns": [
"time",
"userCount",
"roomCount",
"peakCurrentChannels",
"peakCurrentUsers"
],
"Values": [
[
1664553600,
16,
12,
0,
0
],
[
1664640000,
17,
13,
0,
0
],
[
1664726400,
14,
11,
0,
0
],
[
1664812800,
16,
12,
0,
0
],
[
1664899200,
17,
12,
0,
0
],
[
1664985600,
17,
12,
0,
0
],
[
1665072000,
16,
14,
0,
0
],
[
1665158400,
29,
21,
0,
0
],
[
1665244800,
43,
32,
0,
0
],
[
1665331200,
42,
32,
0,
0
],
[
1665417600,
47,
31,
0,
0
],
[
1665504000,
51,
35,
0,
0
],
[
1665590400,
49,
34,
0,
0
]
]
}
],
"Total": 1
},
"RequestId": "mg--88gg8wpzr8j26-2wl1xk4pmqfanw"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| UnsupportedOperation | 操作不支持。 |