List metric definitions

GEThttps://spectra.api.aerovy.com/v2/definitions/metrics

Returns a paginated list of metric definitions for the calling organization. Requires an API key with the read action.

Loading code example

Loading code example

Authorizations

apiKeystringheaderrequired

API key passed in the header.

continuationTokenstring

Opaque token from a prior page; omit for the first page.

pageLimitinteger | string<int32>

Page size; omit to use the service default.

Pattern: ^-?(?:0|[1-9]\d*)$

statusstringdefault: active

Filter by lifecycle status: `active` (default), `deleted`, or `all`.

Default: "active"

application/json

A page of metric definitions.

itemsarray<object>

items.metricIdstring

Stable identifier for the metric.

items.namestring

Programmatic name of the metric.

items.displayNamestring

Human-readable name of the metric.

items.descriptionstring

Description of what the metric measures.

items.unitLabelstring

Unit label for the metric's values.

items.dataTypestring

The metric's data type.

items.defaultAggregationstring

Default aggregation used when binning this metric.

items.tagsarray<string>

Free-form tags applied to the metric.

items.enumValuesnull | array

Allowed enumerated values, when the metric is enum-typed.

items.isDeletedboolean

Whether the metric has been soft-deleted.

items.createdAtstring<date-time>

Timestamp (UTC) when the metric was created.

items.updatedAtnull | string<date-time>

Timestamp (UTC) when the metric was last updated.

items.createdBystring

Identifier of the actor that created the metric.

items.updatedBynull | string

Identifier of the actor that last updated the metric.

continuationTokennull | string

hasMoreboolean