1. 接口描述
接口请求域名: adp.tencentcloudapi.com 。
查询应用视图下的调用统计总览,包含总调用次数、调用成功率、总tokens平均耗时及首tokens平均耗时;RAG 应用额外返回各回复方式的调用次数及占比,用于绘制饼图
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAppStatisticsOverview。 | ||||||||||||||||||
| Version | 是 | String | 公共参数,本接口取值:2026-05-20。 | ||||||||||||||||||
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | ||||||||||||||||||
| AppType | 是 | Integer | 应用类型。可选值:APP_TYPE_RAG(RAG)、APP_TYPE_WORKFLOW(Workflow)、APP_TYPE_CLAW(Claw)、APP_TYPE_MULTIAGENT(MultiAgent);本期仅 APP_TYPE_RAG 生效,其余为预留值,传入将返回 InvalidParameter
示例值:1 |
||||||||||||||||||
| TimeRange | 是 | TimeRange | 查询时间范围(Unix 秒) |
||||||||||||||||||
| ViewScope | 是 | ViewScope | 视图范围:应用视图(VIEW_TYPE_APP),scope_id 填应用 ID(uint64 雪花 ID 的十进制字符串) |
||||||||||||||||||
| SpaceId | 是 | String | 空间 ID 参数格式: 空间 ID 默认值:default_space 示例值:default_space |
||||||||||||||||||
| AppId | 是 | String | 应用 ID 参数格式: 应用 ID 参考值:2099767969573745984 示例值:2099767969573745984 |
||||||||||||||||||
| FilterList.N | 否 | Array of Filter | 扩展过滤。Filter 组合规则:多项 AND,同项 value_list OR。支持 Name:space_id(空间 ID)、channel_type(调用方式/渠道类型,取值参考 trpc.adp.common.v2.ChannelType 枚举名);channel_type 不传时按全部渠道聚合 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AvgFirstTokenTime | String | 首 tokens 平均耗时(毫秒) 示例值:0 |
| AvgTotalTokenTime | String | 总 tokens 平均耗时(毫秒) 示例值:0 |
| CallSuccessRate | Float | 应用调用成功率(百分比,0~100) 示例值:0 |
| ReplyTypeDistributionList | Array of Distribution | 回复类型分布列表;按 app_type 统计,已补全所有回复方式并按固定顺序返回,无数据的回复方式 call_count 为 0 |
| TotalCallCount | String | 总调用次数 示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeAppStatisticsOverview 查询用户详情
输入示例
POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAppStatisticsOverview
<公共请求参数>
{
"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": "问答直接回复"
}
],
"TotalCallCount": "0",
"RequestId": "5f6d2237-9741-4788-b442-56feb1022bab"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |