You need to enable JavaScript to run this app.
Application Performance Management Plus

Application Performance Management Plus

Copy page
Download PDF
Exceptions and crashes
GetAppSummaryData
Copy page
Download PDF
GetAppSummaryData
Obtain summary data for app crashes.​
Request description​
RUM is deployed across multiple regions worldwide to provide more stable and low-latency access. You can refer to the Service addresses topic to choose the most suitable access point based on your business location.​
  • Request method: POST​
  • Request URL: https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAppSummaryData&Version=2025-12-01​
Request parameters​
The following table lists only the request parameters specific to this API and some public parameters. For details, see Public parameters.​
tip​
Before you call this API, specify the required public request parameters (such as x-app-ids). Otherwise, the call fails.​
​
Parameters​
Type​
Required​
Sample value​
Description​
Action​
String​
Yes​
GetAppSummaryData​
The API name. The API name is GetAppSummaryData.​
Version​
String​
Yes​
2025-12-01​
The API version. The API version is 2025-12-01.​
Aid​
Long​
Yes​
123456​
The app ID.​
StartTime​
Long​
Yes​
1665417600​
The timestamp of the query start time. Unit: seconds.​
EndTime​
Long​
Yes​
1665504000​
The timestamp of the query end time. Unit: seconds.​
BizType​
String​
Yes​
crash​
The exception type. Values:​
  • crash: Crash​
  • crash_defend: Crash protection​
  • lag: Lag​
  • custom_exception: Custom exception​
Filters​
Object of Condition​
No​
-​
The filter condition.​
CompareStartTime​
Long​
Yes​
1665331200​
The timestamp of the comparison start time. Unit: seconds.​
The start time and end time form a query time window. The comparison start time and comparison end time form another time window for period-over-period analysis. Typically, the comparison time window has the same duration as the query time window and is the adjacent period immediately before the query time window.​
For example, if the start time is 2023-03-05 00:00:00 and the end time is 2023-03-08 00:00:00, then the comparison start time is 2023-03-02 00:00:00 and the comparison end time is 2023-03-05 00:00:00.​
CompareEndTime​
Long​
Yes​
1665417600​
The timestamp of the comparison end time. Unit: seconds.​
From​
String​
No​
startup​
The source module. Values:​
  • startup: Startup analysis module​
  • app_page: Page analysis module​
Status​
Array of String​
No​
["pending","solved"]​
The list of issue states. You can configure multiple states simultaneously. Values:​
  • pending​
  • processing​
  • ignored​
  • solved​
  • reopen​
Tags​
Array of Long​
No​
[]​
The list of tag IDs.​
Token​
String​
No​
keyword​
The search keyword.​
IsNew​
Integer​
No​
0​
Whether it is a new issue. Values:​
  • 0: This is not a new issue.​
  • 1: This is a new issue.​
Managers​
Array of Long​
No​
[]​
The IDs of the persons responsible for this issue.​
TimeType​
String​
No​
api_time​
The time type. Values:​
  • api_time: Report time (default)​
  • event_time: Occurrence time​
GroupFields​
Array of String​
No​
[]​
The list of grouping fields.​
​
Condition​
​
Parameters​
Type​
Required​
Sample value​
Description​
Op​
String​
No​
in​
The operator. Values:​
  • gt: greater than​
  • gte: greater than or equal to​
  • lt: less than​
  • lte: less than or equal to​
  • eq: equal to​
  • neq: not equal to​
  • in: contains​
  • not_in: does not contain​
  • lk: Matches data that fits a specific pattern.​
  • nlk: Excludes data that fits a specific pattern.​
Type​
String​
No​
expression​
The type of the filter condition. Sample value:​
  • expression: The current condition is a single expression.​
  • and: The current condition is a compound expression, and the sub-conditions in SubConditions are in a logical AND relationship.​
  • or: The current condition is a compound expression, and the sub-conditions in SubConditions are in a logical OR relationship.​
  • map: The current condition is of the map type.​
Value​
String​
No​
123456​
The filter value.​
MapKey​
String​
No​
key_1​
The key of the map type.​
tip​
This parameter is required when type is set to map.​
Values​
Array of String​
No​
[123456]​
The filter values. You can configure multiple values simultaneously.​
Dimension​
String​
No​
aid​
The name of the condition.​
SubConditions​
Array of Condition​
No​
[]​
The sub-condition.​
​
Sample request​
​
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": []​
}
​
Response parameters​
​
Parameters​
Type​
Sample value​
Description​
CrashUser​
Object of SummaryMetric​
-​
The number of users affected by the crash.​
CrashCount​
Object of SummaryMetric​
-​
The number of crashes.​
CrashRatio​
Object of SummaryMetric​
-​
The crash rate.​
CrashUserRatio​
Object of SummaryMetric​
-​
The ratio of users affected by the crash.​
AvgProcessCpuRate​
Object of SummaryMetric​
-​
The average process CPU utilization.​
CpuReportCntPerLanuch​
Object of SummaryMetric​
-​
The average number of CPU reports per launch.​
CpuExceptionUserAllRate​
Object of SummaryMetric​
-​
The overall ratio of users affected by CPU exceptions.​
CpuExceptionUserAvgRate​
Object of SummaryMetric​
-​
The average ratio of users affected by CPU exceptions.​
​
SummaryMetric​
​
Parameters​
Type​
Sample value​
Description​
Rate​
Double​
0.25​
The change rate. Calculation formula: Change rate = (Current value - Comparison value) / Comparison value.​
Compare​
Double​
8.0​
The comparison value.​
Current​
Double​
10.0​
Current value.​
​
Sample response​
​
{​
"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​
}​
}​
}
​
Error codes​
No error codes are specific to this API. If the API call returns an error code, refer to Public error codes for troubleshooting.​
Last updated: 2026.09.16 17:52:21