Get the list of pages where JavaScript errors occurred.

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=JSOverviewPageList&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	JSOverviewPageList	The API name. The API name is JSOverviewPageList.
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.
filter_conditions	Object of FilterCondition	No	-	The filter condition.
order_by	String	No	count_ascend	The sorting method. count_ascend count_descend user_ascend user_descend
pgno	Long	No	1	Page number.
pgsz	Long	No	10	Number of items per page.

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 type of the first level must be "and", and the type of the second level must be "rule".
field	String	No	pid	Condition field key. Available values can be obtained via the GetFieldKeys API.
op	String	No	in	Condition operators. Optional values are eq, neq, lt, lte, gt, gte, in, not_in, regex, and not_regex.
groupKey	String	No	context	Map type field key. The set of optional values can be obtained by the GetFieldKeys method.
values	Array of String	No	[data explore]	Condition values. The set of optional values can be obtained by the GetFieldValues method.
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
error_msg	String	-	Error message. If the request was successful, this field is empty.
error_no	Integer	0	Error code. 0 indicates success.
data	Object of OverviewPageListResponseData	-	Aggregated lists of pages where JavaScript errors occurred.

OverviewPageListResponseData

Parameters	Type	Sample value	Description
total	Long	10	Total number of page clusters where JavaScript errors occurred.
result	Array of PageListItem	-	A list of pages with JS errors on the specified page number.

PageListItem

Parameters	Type	Sample value	Description
pid	String	pid_test	Page ID (page_id).
user	Long	10	Number of users affected by JavaScript errors.
count	Long	10	Errors and number of user count JavaScript errors.
user_mini_chart	Object of ChartData	-	The trend in the number of users affected by JavaScript errors.
count_mini_chart	Object of ChartData	-	JavaScript error occurrence trend.

ChartData

Parameters	Type	Sample value	Description
fields	Array of Field	-	Line chart/pie chart dimensions. len(fields)=len(source[i]).
source	Array of String	[["1668355200","js_error","0","0"]]	The set of specific points in the trend chart. len(source) is the number of points in the line chart or the number of blocks in the pie chart.

Field

Parameters	type	Sample value	Description
id	String	date	Dimension key.
name	String	Date	Dimension name.
dataType	String	string	Dimension type.
aggregate	String	-	Aggregation method.

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