tencent cloud



Last updated: 2023-12-07 10:46:28

    1. API Description

    Domain name for API request: tiw.tencentcloudapi.com.

    This API is used to query the quality data of a whiteboard application.

    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 Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeQualityMetrics.
    Version Yes String Common Params. The value used for this API: 2019-09-19.
    Region No String Common Params. This parameter is not required for this API.
    SdkAppId Yes Integer SdkAppId of the whiteboard application.
    StartTime Yes Integer Start time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
    EndTime Yes Integer End time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
    Metric Yes String Metrics to be queried. Valid values:
    - image_load_total_count: The number of image loads.
    - image_load_fail_count: The number of image load failures.
    - image_load_success_rate: The success rate of image loading, in percentage.
    - ppt_load_total_count: The number of PowerPoint file loads.
    - ppt_load_fail_count: The number of PowerPoint file load failures.
    - ppt_load_success_rate: The success rate of PowerPoint file loading, in percentage.
    - verify_sdk_total_count: The number of SDK verifications.
    - verify_sdk_fail_count: The number of SDK verification failures.
    - verify_sdk_success_rate: The success rate of SDK verification, in percentage.
    - verify_sdk_in_one_second_rate: The rate of SDK verification completed within one second, in percentage.
    - verify_sdk_cost_avg: The average time taken by each SDK verification, in milliseconds.
    Interval No String Aggregation interval. Valid value: 1h.

    3. Output Parameters

    Parameter Name Type Description
    Metric String Query metrics.
    Content Array of TimeValue Time series.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying image loading failures of a whiteboard application

    Input Example

    POST / HTTP/1.1
    Host: tiw.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeQualityMetrics
    <Common request parameters>
        "SdkAppId": 1400296030,
        "Metric": "image_load_fail_count",
        "Interval": "1h",
        "StartTime": 1617874404,
        "EndTime": 1618479204

    Output Example

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

    5. Developer Resources


    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InvalidParameter A parameter error occurred.
    UnauthorizedOperation Unauthorized operation.
    UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support