Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Metric

Get metric evaluation results

Retrieve metric evaluation results that match the given filters.

Permissions

This endpoint may be impacted by the following permissions:

  • Only metric evaluation results that the authenticated user has Metric:GetMetricEvaluationResult permission for will be retrieved.
get/v1/{organization}/metric/metric_evaluation_result

Path parameters

organizationstring required

Query parameters

limitinteger

The maximum number of metrics to return.

The maximum number of metrics to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of metrics.

The continuation token from the previous request used to retrieve the next page of metrics.

timestamp_afterstring date-time nullable

An ISO8601 timestamp. Only results evaluated on or after this moment is returned.

An ISO8601 timestamp. Only results evaluated on or after this moment is returned.

timestamp_beforestring date-time nullable

An ISO8601 timestamp. Only results evaluated on or before this moment is returned.

An ISO8601 timestamp. Only results evaluated on or before this moment is returned.

metric_idstring[]

The ID of the metric to retrieve.

The ID of the metric to retrieve.

metric_id_and_versionstring[]

The metric IDs and their versions to retrieve. Each value must be in the format of <metric_id>-<version>. If version is left empty, any versions of the metric would be retrieved.

The metric IDs and their versions to retrieve. Each value must be in the format of <metric_id>-<version>. If version is left empty, any versions of the metric would be retrieved.

source_typeEvaluationSourceType[]

The type of the source of the metric evaluation results.

The type of the source of the metric evaluation results.

conversation_idstring[]

For metric evaluation sources with type post-session or manual, this field filters the metric evaluation results to only include those that were computed from the given conversation IDs.

For metric evaluation sources with type post-session or manual, this field filters the metric evaluation results to only include those that were computed from the given conversation IDs.

simulation_unit_test_set_run_idstring[]

For metric evaluation sources with type simulation, this field filters the metric evaluation results to only include those that were computed from the given simulation unit test set run IDs.

For metric evaluation sources with type simulation, this field filters the metric evaluation results to only include those that were computed from the given simulation unit test set run IDs.

sort_bystring[]

The fields to sort the metrics by. Supported fields are created_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

The fields to sort the metrics by. Supported fields are created_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded

has_moreboolean required

Whether there are more metric evaluation results to retrieve.

{"stackTrail":"components:schemas:src__app__endpoints__metric__get_metric_evaluation_results__Response:properties:continuation_token:anyOf","oasType":"schema","type":"unknown","title":"Continuation Token","description":"The continuation token to use to retrieve the next set of metric evaluation results.","nullable":true}