tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAppStatistics

Last updated: 2023-07-06 14:47:52

1. API Description

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

This API is used to query the usage statistics of a GME application, including those of Voice Chat, Voice Message Service, Voice Analysis, etc. The maximum query period is the past 30 days.

A maximum of 200 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: DescribeAppStatistics.
Version Yes String Common Params. The value used for this API: 2018-07-11.
Region No String Common Params. This parameter is not required.
BizId Yes Integer GME application ID
StartDate Yes Date Data start date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13.
EndDate Yes Date Data end date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13.
Services.N Yes Array of String List of services to be queried. Valid values: RealTimeSpeech, VoiceMessage, VoiceFilter, SpeechToText.

3. Output Parameters

Parameter Name Type Description
Data DescribeAppStatisticsResp Application usage statistics
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the usage statistics of Voice Chat and Voice Message Service between August 1 and August 3, 2019

This example shows you how to query the usage statistics of Voice Chat and Voice Message Service between August 1 and August 3, 2019.

Input Example

POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAppStatistics
<Common request parameters>

{
    "Services": [
        "VoiceMessage",
        "RealTimeSpeech"
    ],
    "StartDate": "2019-08-01",
    "EndDate": "2019-08-03",
    "BizId": "140000001"
}

Output Example

{
    "Response": {
        "Data": {
            "AppStatistics": [
                {
                    "VoiceFilterStatisticsItem": {
                        "Duration": 1
                    },
                    "RealtimeSpeechStatisticsItem": {
                        "MainLandPcu": 1,
                        "OverseaDuration": 1,
                        "OverseaPcu": 1,
                        "OverseaDau": 1,
                        "MainLandDuration": 1,
                        "MainLandDau": 1
                    },
                    "StreamTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "RealtimeTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "VoiceMessageStatisticsItem": {
                        "Dau": 1
                    },
                    "AudioTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "Date": "2020-09-22",
                    "OverseaTextStatisticsItem": {
                        "Data": 0.0
                    }
                },
                {
                    "VoiceFilterStatisticsItem": {
                        "Duration": 1
                    },
                    "RealtimeSpeechStatisticsItem": {
                        "MainLandPcu": 1,
                        "MainLandDuration": 1,
                        "OverseaPcu": 1,
                        "OverseaDau": 1,
                        "OverseaDuration": 1,
                        "MainLandDau": 1
                    },
                    "Date": "2020-09-22",
                    "StreamTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "RealtimeTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "VoiceMessageStatisticsItem": {
                        "Dau": 1
                    },
                    "AudioTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "OverseaTextStatisticsItem": {
                        "Data": 0.0
                    }
                },
                {
                    "VoiceFilterStatisticsItem": {
                        "Duration": 1
                    },
                    "RealtimeSpeechStatisticsItem": {
                        "MainLandPcu": 1,
                        "MainLandDuration": 1,
                        "OverseaPcu": 1,
                        "OverseaDau": 1,
                        "OverseaDuration": 1,
                        "MainLandDau": 1
                    },
                    "Date": "2020-09-22",
                    "StreamTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "RealtimeTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "VoiceMessageStatisticsItem": {
                        "Dau": 1
                    },
                    "AudioTextStatisticsItem": {
                        "Data": 0.0
                    },
                    "OverseaTextStatisticsItem": {
                        "Data": 0.0
                    }
                }
            ]
        },
        "RequestId": "099d942a-f5c5-40d2-b96b-5c26a35813e0"
    }
}

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

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.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.DateInvalid Invalid date.
InvalidParameter.DateOutOfSixtyDays The entered query date range is longer than 60 days.
InvalidParameter.TimeRangeError Incorrect query time range.
ResourceNotFound The resource does not exist.
ResourceNotFound.BizidIsNotFound Incorrect application ID.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Operation unsupported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy