API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 互动白板 > 统计查询相关接口 > 查询质量数据

查询质量数据

最近更新时间：2024-03-12 01:56:22

我的收藏

本页目录：

1. 接口描述

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

查询互动白板质量数据

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeQualityMetrics。
Version 是 String 公共参数，本接口取值：2019-09-19。
Region 是 String 公共参数，详见产品支持的 地域列表。
SdkAppId 是 Integer 白板应用的SdkAppId
示例值：1400000001
StartTime 是 Integer 开始时间，Unix时间戳，单位秒，时间跨度不能超过7天
示例值：1614691834
EndTime 是 Integer 结束时间，Unix时间戳，单位秒，时间跨度不能超过7天
示例值：1614691834
Metric 是 String 查询的指标，目前支持以下值
- image_load_total_count: 图片加载总数（单位，次）
- image_load_fail_count: 图片加载失败数量（单位，次）
- image_load_success_rate: 图片加载成功率（百分比）
- ppt_load_total_count: PPT加载总数（单位，次）
- ppt_load_fail_count: PPT加载失败总数（单位，次）
- ppt_load_success_rate: PPT加载成功率（单位，百分比）
- verify_sdk_total_count: 白板鉴权总次数（单位，次）
- verify_sdk_fail_count: 白板鉴权失败次数（单位，次）
- verify_sdk_success_rate: 白板鉴权成功率（单位，百分比）
- verify_sdk_in_one_second_rate: 白板鉴权秒开率（单位，百分比）
- verify_sdk_cost_avg: 白板鉴权耗时平均时间（单位，毫秒）
示例值：image_load_success_rate
Interval 否 String 聚合的时间维度，目前只支持1小时，输入值为"1h"
示例值：1h

3. 输出参数

参数名称 类型 描述
Metric String 输入的查询指标
示例值：image_load_success_rate
Content Array of TimeValue 时间序列
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询白板图片加载失败统计

输入示例

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

{
    "SdkAppId": 1400296030,
    "Metric": "image_load_fail_count",
    "Interval": "1h",
    "StartTime": 1617874404,
    "EndTime": 1618479204
}

输出示例

{
    "Response": {
        "RequestId": "6c41b5df-2326-4c0b-baca-2fd85ebb4097",
        "Metric": "image_load_fail_count",
        "Content": [
            {
                "Time": 1617872400,
                "Value": 0
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。
中国站