Get the list of available grouping and filtering items for the specified event type.

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=PCAlarmMeasureRelatedMeta&Version=2022-10-28

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	PCAlarmMeasureRelatedMeta	The API name. The API name is PCAlarmMeasureRelatedMeta.
Version	String	Yes	2022-10-28	The API version. The current API version is 2022-10-28.
common	Object of CommonParams	Yes	-	Public parameters.
measure	Object of FlexMeasure	Yes	-	Metric set.

CommonParams

Parameters	Type	Required	Sample value	Description
os	String	Yes	pc	Operating system.
aid	Long	Yes	12345	App ID.
env	String	No	crash	Environment information.

FlexMeasure

Parameters	Type	Required	Sample value	Description
name	String	Yes	crash_affected_users	The metric name.
type	String	Yes	monomial	Metric type. monomial polynomial
customId	String	No	xe3ejx98	Used by the frontend to restore the page.
raw_measure_list	Array of FlexRawMeasure	Yes	-	Specific query metrics.

FlexRawMeasure

Parameters	Type	Required	Sample value	Description
event_name	String	No	test_service_gyf	This parameter is passed by the frontend but not used by the backend. However, when the system restores the chart, it reads the event name from this field.
filter_list	Array of FlexFilter	No	-	Filter condition.
measure_name	String	Yes	"{"metric":"pc_flexible.count","event_dimension":"pc_flexible.event_name","event_name":"test_service_gyf"}"	Value calculated for a specific metric.

FlexFilter

Parameters	Type	Required	Sample value	Description
op	String	Yes	in	Filtering method.
values	Array of String	Yes	["intel", "Qualcomm"]	Filter values.
filter_name	String	Yes	cpu	Indicates the dimension of the filter.

Sample request

Response parameters

Parameters	Type	Sample value	Description
data	Object of AlarmMeasureRelatedMeta	-	Response data.
errmsg	String	""	Error message. If the request was successful, this field is empty.
errno	Integer	200	Error code. If the request was successful, this field is 200.

AlarmMeasureRelatedMeta

Parameters	Type	Sample value	Description
group_meta_list	Array of FlexGroupByMeta	-	Grouping options.
filter_meta_list	Array of FlexFilterMeta	-	Filtering options.

FlexGroupByMeta

Parameters	Type	Sample value	Description
label	String	name	Displayed name.
group_by_name	String	os	The grouping field.
related_measure_name	Array of String	["event1"]	Related metric name.

FlexFilterMeta

Parameters	Type	Sample value	Description
label	String	osVersion	Display name.
filter_name	String	os_version	Filter name.
filter_type	String	string	Filtering method. number string regex
filter_name_type	Integer	0	Filtering value type 0: Field 1: Calculation

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