You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
异常和崩溃
GetAppSummaryData
复制全文
下载 pdf
GetAppSummaryData
获取 App 崩溃各汇总数据。
请求说明
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。
  • 请求方式:POST
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAppSummaryData&Version=2025-12-01
请求参数
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数
说明
调用本接口前,请在请求中传入必填的公共请求参数(如 x-app-ids),否则将调用失败。
参数
类型
是否必选
示例值
描述
Action
String
GetAppSummaryData
接口名称。当前 API 的名称为 GetAppSummaryData
Version
String
2025-12-01
接口版本。当前 API 的版本为 2025-12-01
Aid
Long
123456
应用 ID。
StartTime
Long
1665417600
查询开始时间的时间戳,单位:秒。
EndTime
Long
1665504000
查询结束时间的时间戳,单位:秒。
BizType
String
crash
异常类型。取值:
  • crash:崩溃
  • crash_defend:崩溃防护
  • lag:卡顿
  • custom_exception:自定义异常
Filters
Object of Condition
-
筛选条件。
CompareStartTime
Long
1665331200
对比开始时间的时间戳,单位:秒。
开始时间和结束时间构成一个查询时间窗口。对比开始时间和对比结束时间构成另一个用于环比分析的时间窗口。通常情况下,对比时间窗口的时长与查询时间窗口相同,且位于查询时间窗口之前的相邻周期。
例如,开始时间为2023-03-05 00:00:00,结束时间为2023-03-08 00:00:00。则对比开始时间为2023-03-02 00:00:00,对比结束时间为2023-03-05 00:00:00。
CompareEndTime
Long
1665417600
对比结束时间的时间戳,单位:秒。
From
String
startup
来源模块。取值:
  • startup:启动分析模块
  • app_page:页面分析模块
Status
Array of String
["pending","solved"]
issue 状态列表,支持同时配置多个。取值:
  • pending:未修复
  • processing:修复中
  • ignored:已忽略
  • solved:已修复
  • reopen:重复出现
Tags
Array of Long
[]
标签 ID 列表。
Token
String
keyword
搜索关键字。
IsNew
Integer
0
是否为新增 issue。取值:
  • 0:非新增 issue
  • 1:新增 issue
Managers
Array of Long
[]
责任人的用户 ID 列表。
TimeType
String
api_time
时间类型。取值:
  • api_time:上报时间(默认值)
  • event_time:发生时间
GroupFields
Array of String
[]
分组字段列表。
Condition
参数
类型
是否必选
示例值
描述
Op
String
in
操作符。取值:
  • gt:大于
  • gte:大于等于
  • lt:小于
  • lte:小于等于
  • eq:等于
  • neq:不等于
  • in:包含
  • not_in:不包含
  • lk:模糊匹配特定模式的数据
  • nlk:排除模糊匹配的数据
Type
String
expression
筛选条件类型。示例值:
  • expression:当前条件为单一表达式。
  • and:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“与”关系。
  • or:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“或”关系。
  • map:当前条件为 map 类型。
Value
String
123456
筛选值。
MapKey
String
key_1
map 类型的 key。
说明
type取值为 map 时,必须配置此参数。
Values
Array of String
[123456]
筛选值,支持同时配置多个。
Dimension
String
aid
条件的名称。
SubConditions
Array of Condition
[]
子条件。
请求示例
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAppSummaryData&Version=2025-12-01
{
"Aid": 123456,
"StartTime": 1665417600,
"EndTime": 1665504000,
"BizType": "crash",
"Filters": {},
"CompareStartTime": 1665331200,
"CompareEndTime": 1665417600,
"From": "startup",
"Status": [
"pending",
"solved"
],
"Tags": [],
"Token": "keyword",
"IsNew": 0,
"Managers": [],
"TimeType": "api_time",
"GroupFields": []
}
返回参数
参数
类型
示例值
描述
CrashUser
Object of SummaryMetric
-
崩溃用户数。
CrashCount
Object of SummaryMetric
-
崩溃数。
CrashRatio
Object of SummaryMetric
-
崩溃率。
CrashUserRatio
Object of SummaryMetric
-
崩溃用户率。
AvgProcessCpuRate
Object of SummaryMetric
-
CPU 平均进程使用率。
CpuReportCntPerLanuch
Object of SummaryMetric
-
CPU 单次启动平均上报次数。
CpuExceptionUserAllRate
Object of SummaryMetric
-
CPU 整体影响用户比。
CpuExceptionUserAvgRate
Object of SummaryMetric
-
CPU 平均影响用户比。
SummaryMetric
参数
类型
示例值
描述
Rate
Double
0.25
变化率。计算公式:变化率 =(当前值 - 对比值)/ 对比值。
Compare
Double
8.0
对比值。
Current
Double
10.0
当前值。
返回示例
{
"ResponseMetadata": {
"Action": "GetAppSummaryData",
"Region": "cn-north-1",
"Service": "apmplus_openapi",
"Version": "2025-12-01",
"RequestId": "20230604110420****100232280022D31"
},
"Result": {
"CrashUser": {
"Rate": 0.12,
"Compare": 125,
"Current": 140
},
"CrashCount": {
"Rate": 0.18,
"Compare": 210,
"Current": 247.8
},
"CrashRatio": {
"Rate": 0.25,
"Compare": 0.012,
"Current": 0.015
},
"CrashUserRatio": {
"Rate": 0.15,
"Compare": 0.021,
"Current": 0.02415
},
"AvgProcessCpuRate": {
"Rate": -0.08,
"Compare": 26.5,
"Current": 24.38
},
"CpuReportCntPerLanuch": {
"Rate": 0.1,
"Compare": 2.2,
"Current": 2.42
},
"CpuExceptionUserAllRate": {
"Rate": 0.32,
"Compare": 0.075,
"Current": 0.099
},
"CpuExceptionUserAvgRate": {
"Rate": 0.2,
"Compare": 0.04,
"Current": 0.048
}
}
}
错误码
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。
最近更新时间:2026.08.05 11:25:41
这个页面对您有帮助吗?
有用
有用
无用
无用