Get the blank screen list for different attribution types.

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=BlankScreenOverviewList&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	BlankScreenOverviewList	The API name. The current API name is BlankScreenOverviewList.
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	score	Sorting dimension. score client_time time count user
order	String	No	desc	The sorting method. desc asc
pgno	Long	Yes	1	Page number.
pgsz	Long	Yes	10	Number of items per page.
type	String	Yes	js_error	Attribution type. js_error resource_error http_error unclassified

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, 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. Empty indicates success.
data	Object of OverviewListResponseDataV2	-	Blank-screen attribution aggregation list.

OverviewListResponseDataV2

Parameters	Type	Sample value	Description
js_error	Object of OverviewErrorListResponseData	-	List of white screen cases caused by JS errors.
http_error	Object of ReqErrorResponseData	-	List of blank screens caused by request errors.
unclassified	Object of OverviewListResponseData	-	List of unattributable blank screens.
resource_error	Object of ResourceErrorResponseData	-	List of blank screens caused by static resource errors.

OverviewErrorListResponseData

Parameters	Type	Sample value	Description
total	Long	10	Total number of JS error aggregation types.
result	Array of ErrorListItem	-	JS error aggregation list.

ReqErrorResponseData

Parameters	Type	Sample value	Description
total	Long	10	Total number of request error clusters causing blank screens.
result	Array of ReqErrorListItem	-	Aggregation list of request errors causing blank screens.

OverviewListResponseData

Parameters	Type	Sample value	Description
total	Long	10	Unattributable blank screen count.
result	Array of ListItem	-	List of unattributable blank screens.

ResourceErrorResponseData

Parameters	Type	Sample value	Description
total	Long	10	Total number of static resource error clusters causing blank screens.
result	Array of ResourceErrorListItem	-	Aggregation list of static resource errors causing blank screens.

ErrorListItem

Parameters	Type	Sample value	Description
message	String	Minified React error	Error message.
name	String	Error	Error type.
filename	String	12345.js	Error file name.
issue_id	String	12345	Issue status operation
issue	Object of IssueInfo	-	Issue assignment information.
meego_issue_url	String	-	If issue_status is not done, this field is not set.
level	String	-	Start and end time.
max_crash_time	Long	1667441262510	Occurrence time of the latest JS error within the currently selected time range.
min_crash_time	Long	1666781177513	Error and user count.
count	Long	10	Errors and number of user count errors.
count_mini_chart	Object of ChartData	-	Error count trend.
user	Long	10	Affected user count.
user_mini_chart	Object of ChartData	-	Affected user trend.

ReqErrorListItem

Parameters	Type	Sample value	Description
path	String	path_test	Request error path.
user	Long	10	Number of users affected by request errors.
count	Long	10	Request error count.
domain	String	www.test.com	Request error domain.
user_trend	Object of ChartData	-	Trend of the number of users affected by request errors.
count_trend	Object of ChartData	-	Request error trend.
distribution	Object of ChartData	-	Distribution of request error status codes.

ListItem

Parameters	Type	Sample value	Description
pid	String	path_test	Blank screen page PID.
url	String	https://www.test.com/path_test?key1=value1	Blank screen page URL.
score	Double	0	Blank screen score.
screenshot	String	data:image/jpeg;base64,/9j/4AAQS	Base64-encoded value of the blank screen on-site screenshot.
session_id	String	049437a9	session_id associated with the blank screen.
client_time	Long	1667313554658	Client time when the blank screen occurred.

ResourceErrorListItem

Parameters	Type	Sample value	Description
url	String	-	Static resource error URL.
path	String	path_test	Static resource error path.
type	String	resource	Static resource error type.
user	Long	10	Number of users affected by static resource errors.
count	Long	10	Static resource error count.
domain	String	www.test.com	Static resource error domain.
user_trend	Object of ChartData	-	Trend of the number of users affected by static resource errors.
count_trend	Object of ChartData	-	Trend of static resource error count.

IssueInfo

Parameters	Type	Sample value	Description
managers	Array of IssueManager	-	Issue assignee.
status	String	processing	Issue status.
fixed_version	String	v1.1.2	The fixed version.

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.

IssueManager

Parameters	Type	Sample value	Description
name	String	test_user	Assignee name.
email	String	test_user@test.com	Assignee email.
user_id	Long	12	Assignee ID.

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