View metric data listed on the page.

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=MiniproUrlListUrlList&Version=2024-03-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	MiniproUrlListUrlList	The API name. The current API name is MiniproUrlListUrlList.
Version	String	Yes	2024-03-12	The API version. The current API version is 2024-03-12.
common	Object of Common	No	-	Common parameters.
time_filter	Object of TimeFilter	No	-	Time filter.
filter_conditions	Object of FilterConditions	No	-	The filter condition.
page_num	Integer	No	1	Number of pages when paginating.
page_size	Integer	No	10	Number of items per page when paginating.
order	String	No	asc	The sorting method. asc: Ascending order desc: Descending order
order_by_metric	String	No	count	A field for sorting. count: By absolute number user: By user count
search_text	String	No	test	Fuzzy search text.
metric_list	Array of MetricList	No	-	Metric list. It can be obtained via the UrlListOverviewMetrics API.

Common

Parameters	Type	Required	Sample value	Description
aid	Long	Yes	392926	The app ID.

TimeFilter

Parameters	Type	Required	Sample value	Description
start_time	Integer	Yes	1762088409	Start time.
granularity	Integer	No	10800	Time granularity.
end_time	Integer	Yes	1762347609	End time.

FilterConditions

Parameters	Type	Required	Sample value	Description
type	String	Yes	and	The type of the filter condition. and: The conditions in children are in an "AND" relationship. rule: (Default) The current condition is an atomic condition.
field	String	No	pid	Condition field.
op	String	No	in	Condition operators. Available values include: eq, neq, lt, lte, gt, gte, in, not _in, regex, not_regex.
values	Array of String	No	["test"]	Value of the filter criteria. The set of available values can be obtained via the MiniProGetFieldValues API.
children	Array of	No	-	Sub-parameters of the filter criteria. Required only when the type value is and. Nesting is allowed under children, but it cannot coexist with op, field, or values.

MetricList

Parameters	Type	Required	Sample value	Description
description	String	No	PV	Metric description.
groupKey	String	No	base	Metric aggregation key.
groupName	String	No	User analysis	Metric aggregation name.
name	String	No	pv_count	The metric name.
isDefault	Boolean	No	true	Whether it is a default metric.
type	String	No	number	Metric type.
unit	String	No	ms	Unit.

Sample request

Response parameters

Parameters	Type	Sample value	Description
data	Object of Data	-	Returned data.
error_msg	String	""	Error message.
error_no	Integer	0	Error code.

Data

Parameters	Type	Sample value	Description
table_list	Array of TableList	-	Table data.
count	Integer	17	Total number of table data items.
summary_metric	JSON Map	-	Aggregate statistical metric data.

TableList

Parameters	Type	Sample value	Description
metric_map	JSON Map	-	Metric details.
name	String	PID	Data row header name.
link	String	page one	Data row header value.
onTop	Boolean	true	Defaults to false. It is true if it is the page pinned by the user.

SummaryMetric

Parameters	Type	Sample value	Description
key	String	js_error_error_count	Field name of the aggregated statistical metric.
value	Object of Value	-	Aggregated statistical metric field value.

MetricMap

Parameters	Type	Sample value	Description
key	String	js_error_error_count	Metric field name.
value	Object of Value	-	Metric field value.

Value

Parameters	Type	Sample value	Description
change	Double	0.0068	Data change rate.
value	Double	2807	Current value.
positive	Boolean	true	"true" indicates growth. "false" indicates decline.

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