Get the action event list.

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=GetActionOverviewList&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	GetActionOverviewList	The API name. The current API name is GetActionOverviewList.
Version	String	Yes	2022-10-12	The API version. The current API version is 2022-10-12.
common	Object of CommonParams	Yes	-	Common parameters.
time_filter	Object of TimeFilter	Yes	-	Time range.
pgno	Long	No	1	The page number for a pagination query.
pgsz	Long	No	10	The number of items per page for a pagination query.
filter_conditions	Object of FilterCondition	No	-	The filter condition.
order_by	String	No	longtask_count	Sorting basis. action_duration: Action duration frontend_duration: Frontend duration request_duration: Request time count: Action count triggered http_count: Average request count triggered js_err_count: Total JS error count longtask_count: Long task count longtask_duration: Long task time
metric_type	String	No	avg	Duration metric statistical method. avg (default) pct50 pct75 pct90 pct95

CommonParams

Parameters	Type	Required	Sample value	Description
aid	Long	Yes	12345	Application ID.
site_type	String	Yes	web	Site type.
env	String	Yes	online	Environment. An empty string "" indicates all.
os	String	No	webpro	Service type. Available values are webpro, app, and minipro.
user	String	No	test_user	Username.

TimeFilter

Parameters	Type	Required	Sample value	Description
start_time	Integer	Yes	1665485413	Start time, in seconds.
end_time	Integer	Yes	1665744613	End time, in seconds.
granularity	Integer	No	3600	Aggregation time granularity, in seconds.

FilterCondition

Parameters	type	Required	Sample value	Description
type	String	Yes	and	Filter condition type. Available values are and and rule. Only two levels are supported. The first level type must be "and", and the second level type must be "rule".
field	String	No	pid	Condition field key. Available values can be obtained via the GetFieldKeys API.
op	String	No	in	Condition operator. Available values: eq, neq, lt, lte, gt, gte, in, not_in, regex, not_regex.
groupKey	String	No	context	Map type field key. Available values can be obtained via the GetFieldKeys API.
values	Array of String	No	[Data explore]	Criterion values. Available values can be obtained via the GetFieldValues API.
children	Array of FilterCondition	No	-	If there are conditions at the next level, put them here. This parameter is required when type is and. This level cannot coexist with field, op, groupkey, and values.

Sample request

Response parameters

Parameters	Type	Sample value	Description
errno	Integer	0	Error code. 0 indicates success.
errmsg	String	""	Error message.
data	Object of ActionListData	-	Returned data.

ActionListData

Parameters	Type	Sample value	Description
data	Array of ActionListItem	-	Returned data.
total	Long	10	Number of returned data entries.

ActionListItem

Parameters	Type	Sample value	Description
pid	String	Data explore	Page ID.
metric_map	JSON Map	-	Metric set.
action_type	String	click	Action type.
action_target_name	String	Description	Action name.

MetricMap

Parameters	Type	Sample value	Description
key	String	action_count	Metric key. For example, duration, frontend_duration, and http_count.
value	String	128	The metric value corresponding to the key.

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