Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Metric

Get metrics

Retrieve metrics that match the given filters.

Permissions

This endpoint may be impacted by the following permissions:

  • Only metrics that the authenticated user has Metric:GetMetric permission for will be retrieved.
get/v1/{organization}/metric/

Path parameters

organizationstring required

Query parameters

idstring[]

The IDs of the metrics to retrieve.

The IDs of the metrics to retrieve.

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.

applied_to_servicestring[]

The IDs of the services that the metric is applied to.

The IDs of the services that the metric is applied to.

typeMetricValueType[]

The types of the metrics.

The types of the metrics.

is_deletedboolean

Whether the metric is deleted.

Whether the metric is deleted.

creatorstring[]

The creators of the dynamic behavior sets.

The creators of the dynamic behavior sets.

tagstring[]

The tags of the dynamic behavior sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

The tags of the dynamic behavior sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

sort_bystring[]

The fields to sort the sets by. Supported fields are updated_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 sets by. Supported fields are updated_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 metrics to retrieve.

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