Obtains the list of evaluation sets for the specified evaluation platform type and workspace.

Request description

Server-side Monitoring has been deployed in multiple regions around the world to provide you with a more stable and low-latency access experience. 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-server.cn-beijing.volcengineapi.com?Action=ListEvaluationSets&Version=2024-07-30

Request parameters

The following table lists only the request parameters specific to this API and some common parameters. For details, see Common parameters.

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListEvaluationSets	The API name. The current API name is ListEvaluationSets.
Version	String	Yes	2024-07-30	The API version. The current API version is 2024-07-30.
ExportTarget	Integer	Yes	2	Export target. Values: 2: AgentKit evaluation 3: DataFinder evaluation
WorkspaceId	String	Yes	ws-12345	Workspace ID of evaluation platform.
Filter	Object of ListEvaluationSetsRequestFilter	No	{"Name":"Trace"}	Evaluation set filter criteria.
CozeToken	String	No	pat_xxx	Authorization token for accessing CozeLoop. tip This parameter is required when querying CozeLoop.

ListEvaluationSetsRequestFilter

Parameters	Type	Required	Sample value	Description
Name	String	No	Trace	Evaluation set name filter criteria.

Sample request

Response parameters

Parameter	type	Sample value	Description
Items	Array of EvaluationSet	[{"ID":"eval-set-67890","Name":"Trace Evaluation Set","Description":"Evaluation set for Trace data","Fields":[]}]	Evaluation set list.
TotalCount	Long	1	Total number of evaluation sets.

EvaluationSet

Parameters	Type	Sample value	Description
ID	String	eval-set-67890	Evaluation set ID.
Name	String	Trace Evaluation Set	Evaluation set name.
Fields	Array of FieldSchema	[{"Name":"trace_id","Description":"Trace ID","ContentType":"Text","IsRequired":true}]	Field structure list of the evaluation set.
Description	String	Evaluation set for Trace data	Evaluation set description.

FieldSchema

Parameters	Type	Sample value	Description
Name	String	trace_id	Field name.
IsRequired	Boolean	true	Whether the field is required.
TextSchema	String	{"type":"string"}	JSON Schema definition for text fields.
ContentType	String	Text	Field content type.
Description	String	Trace ID	Field description.
DefaultDisplayFormat	String	plain_text	Default display format for fields.

Sample response

Error codes

If the API call returns an exception, you can troubleshoot by referring to the API error codes and the Public error codes below.

HTTP status codes	Error codes	Error messages	Description
500	ErrInternalServerError	We encountered an unexpected server error, please try again later.	Internal server error.

Application Performance Management Plus