Get app battery metrics.

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=GetAppExceptionalBatterySummaryData&Version=2022-10-12

Request parameters

The following table lists only the request parameters specific to this API and some public parameters. For details, see Public parameters.

Parameters	Type	Required	Sample value	Description
Action	String	Yes	GetAppExceptionalBatterySummaryData	The API name. The current API name is GetAppExceptionalBatterySummaryData.
Version	String	Yes	2022-10-12	The API version. The current API version is 2022-10-12.
start_time	Integer	No	1619827200	Current period start time (Unix timestamp).
end_time	Integer	No	1619913600	Current period end time (Unix timestamp).
filters	Object of Condition	No	-	The filter condition. You can specify multiple key‑value pairs to filter data.
compare_start_time	Integer	No	1619730800	Comparison period start time (Unix timestamp).
compare_end_time	Integer	No	1619817200	Comparison period end time (Unix timestamp).
is_new	Integer	No	1	New issue.
status	Array of String	No	["closed"]	A processing state that requires attention.
managers	Array of Long	No	[123456789, 987654321]	A list of manager IDs that require attention.
tags	Array of Long	No	[111, 222]	A list of tag IDs that require attention.
token	String	No	keyword	The search keyword.

Condition

Parameters	Type	Required	Sample value	Description
op	String	No	in	The operator. 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. expression: The current condition is an expression. and: The current condition is a compound expression, and multiple sub-conditions are in an AND logical relationship. or: The current condition is a compound expression, and multiple sub-conditions are in an OR logical relationship. map: The current condition is of map type.
value	String	No	123456	The filter value.
values	Array of String	No	[123456]	The filter value. Multiple filter values are supported.
map_key	String	No	key_1	The key of the map type. It is required when the type is set to map.
dimension	String	No	aid	The name of the condition.
sub_conditions	Array of Condition	No	-	The sub-condition.

Sample request

Response parameters

Parameters	Type	Sample value	Description
data	Object of SummaryResponseData	-	Response data.
error_msg	String	-	Error message.
error_no	Integer	0	Error code.

SummaryResponseData

Parameters	Type	Sample value	Description
battery_trace_cnt	Object of SummaryMetric	-	A metric indicates the number of battery anomalies
battery_trace_user	Object of SummaryMetric	-	Affected user count metric
battery_trace_ratio	Object of SummaryMetric	-	Anomaly rate
battery_trace_user_ratio	Object of SummaryMetric	-	Affected user ratio metric

SummaryMetric

Parameters	Type	Sample value	Description
rate	Double	1.1	The change rate.
compare	Double	90.0	The comparison value.
current	Double	100.0	Current value.

Sample response

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.

Application Performance Management Plus