DescribeAppStatistics

Last updated: 2019-12-05 17:29:52

1. API Description

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

This API is used to get the usage statistics of a GME application, including those of voice chat, voice messaging and speech-to-text, phrase analysis, etc. The maximum query period is the past 30 days.

A maximum of 20 requests can be initiated per second for this API.

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 parameter. The value used for this API: DescribeAppStatistics
Version Yes String Common parameter. The value used for this API: 2018-07-11
Region No String Common parameter. This parameter is not required for this API.
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

3. Output Parameters

Parameter Name Type Description
AppStatistics Array of AppStatisticsItem Application usage statistics

4. Example

Example1 Querying the usage statistics of voice chat and voice messaging and speech-to-text between August 1 and August 3, 2019

Input Example

https://gme.tencentcloudapi.com/?Action=DescribeAppStatistics
&BizId=140000001
&StartDate=2019-08-01
&EndDate=2019-08-03
&Services.0=RealTimeSpeech
&Services.1=VoiceMessage
&<Common request parameter>

Output Example

{
  "Response": {
    "Data": {
      "AppStatistics": [
        {
          "Date": "2019-08-01",
          "RealtimeSpeechStatisticsItem": {
            "MainLandDau": 10000,
            "MainLandPcu": 5000,
            "MainLandDuration": 1000000,
            "OverseaDau": 5000,
            "OverseaPcu": 2000,
            "OverseaDuration": 500000
          },
          "VoiceMessageStatisticsItem": {
            "Dau": 68000
          },
          "VoiceFilterStatisticsItem": null
        },
        {
          "Date": "2019-08-02",
          "RealtimeSpeechStatisticsItem": {
            "MainLandDau": 10000,
            "MainLandPcu": 5000,
            "MainLandDuration": 1000000,
            "OverseaDau": 5000,
            "OverseaPcu": 2000,
            "OverseaDuration": 500000
          },
          "VoiceMessageStatisticsItem": {
            "Dau": 68000
          },
          "VoiceFilterStatisticsItem": null
        },
        {
          "Date": "2019-08-03",
          "RealtimeSpeechStatisticsItem": {
            "MainLandDau": 10000,
            "MainLandPcu": 5000,
            "MainLandDuration": 1000000,
            "OverseaDau": 5000,
            "OverseaPcu": 2000,
            "OverseaDuration": 500000
          },
          "VoiceMessageStatisticsItem": {
            "Dau": 68000
          },
          "VoiceFilterStatisticsItem": null
        }
      ]
    },
    "RequestId": "9b993045-9fa1-47f4-9d25-79160f305be8"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Invalid parameter
InvalidParameter.DateInvalid Invalid date.
InvalidParameter.TimeRangeError Incorrect query time range.
ResourceNotFound The resource does not exist
ResourceNotFound.BizidIsNotFound Application ID does not exist.
UnauthorizedOperation Unauthorized operation
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation