Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Metric

Get metric versions

Retrieve the versions of a metric.

Permissions

This endpoint requires the following permissions:

  • Metric:GetMetric for the metric whose versions to retrieve.
get/v1/{organization}/metric/{metric_id}/version

Path parameters

organizationstring required
metric_idstring required

The ID of the metric to retrieve versions for.

The ID of the metric to retrieve versions for.

Query parameters

versionstring nullable

The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.

Example:1

The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.

limitinteger

The maximum number of metric versions to return.

The maximum number of metric versions to return.

continuation_tokeninteger

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

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

sort_bystring[]

The fields to sort the versions by. Supported fields are version. 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 versions by. Supported fields are version. 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 versions that can be retrieved with further pagination.

continuation_tokeninteger nullable required

The continuation token to be used to retrieve the next page of metric versions. This is only included if has_more is true.