Domain name for API request: adp.intl.tencentcloudapi.com.
This API is used to query the invocation statistics overview under an application view, including the total number of calls, call success rate, avg duration of total tokens, and avg duration of first tokens. For RAG applications, it also returns the count and proportion of calls for each response method for drawing a pie chart.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeAppStatisticsOverview. | ||||||||||||||||||
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. | ||||||||||||||||||
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. | ||||||||||||||||||
| AppType | Yes | Integer | Application type. Available values: APP_TYPE_RAG (RAG), APP_TYPE_WORKFLOW (Workflow), APP_TYPE_CLAW (Claw), APP_TYPE_MULTIAGENT (MultiAgent). In the current period, only APP_TYPE_RAG takes effect. The rest are reserved values. Importing them will return InvalidParameter.
|
||||||||||||||||||
| TimeRange | Yes | TimeRange | Query time range (Unix seconds) |
||||||||||||||||||
| ViewScope | Yes | ViewScope | View scope: application view (VIEW_TYPE_APP). For scope_id, enter the app ID (decimal string of the uint64 snowflake ID) |
||||||||||||||||||
| SpaceId | Yes | String | Space ID Parameter format: Space ID Default value: default_space |
||||||||||||||||||
| AppId | Yes | String | Application ID Parameter format: Application ID Reference value: 2099767969573745984 |
||||||||||||||||||
| FilterList.N | No | Array of Filter | Extended filtering. Filter combination rule: multiple items use AND, and value_list under the same item uses OR. Supported Name: space_id (Space ID), channel_type (calling method/channel type; for values, see the trpc.adp.common.v2.ChannelType Enumeration Name). If channel_type is not specified, aggregation is performed by all channels. |
| Parameter Name | Type | Description |
|---|---|---|
| AvgFirstTokenTime | String | Average first tokens duration (ms) |
| AvgTotalTokenTime | String | Avg duration of total tokens (ms) |
| CallSuccessRate | Float | Application call success rate (percentage, 0-100) |
| ReplyTypeDistributionList | Array of Distribution | Reply type distribution list; statistics by app_type, all reply methods are completed and returned in a fixed sequence. For reply methods with no data, call_count is 0 |
| TotalCallCount | String | Total number of calls |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAppStatisticsOverview
<Common request parameters>
{
"AppType": 1,
"TimeRange": {
"EndTime": "1789487999",
"StartTime": "1789401600"
},
"ViewScope": {
"ViewType": 3,
"ScopeId": "2099767969573745984"
},
"SpaceId": "default_space",
"AppId": "2099767969573745984"
}{
"Response": {
"AvgFirstTokenTime": "0",
"AvgTotalTokenTime": "0",
"CallSuccessRate": 0,
"ReplyTypeDistributionList": [
{
"CallCount": "0",
"Percentage": 0,
"ReplyName": "QA direct reply"
}
],
"TotalCallCount": "0",
"RequestId": "5f6d2237-9741-4788-b442-56feb1022bab"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
文档反馈