Metrics API - GET metric descriptors

Gets the parameters of the specified metrics. You can select up to 10 metrics.

The request produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/metrics/{metricId}
  • SaaS https://{your-environment-id}{metricId}


Parameter Type Description In Required
metricId string

Selects a single metric for the query by its key.

You can set additional transformation operators, separated by a colon (:). See the Metrics API - selector transformations help page for additional information on available result transformations.

The length of the selector string is limited to 1,000 characters.

path required

Response format

The MetricSchemaDto object

The descriptor of a metric.

Element Type Description
aggregationTypes string[]

The list of allowed aggregations for this metric. Must be enabled with the "fields" parameter on /metrics and is always present on /metrics/{metricId}.

metricId string

The fully qualified key of the metric, followed by a transform operator chain.

defaultAggregation MetricStatistic
dimensionDefinitions MetricDimensionDefinition[]

The fine metric division, for example, process group and process ID for some process-related metric.Must be enabled with the "fields" parameter on /metrics and is always present on /metrics/{metricId}.

description string

A short description of the metric.

unit string

The unit of the metric.

displayName string

The name of the metric in the user interface.

The MetricDimensionDefinition object

The dimension of a metric.

Element Type Description
index integer

The unique 0-based index of the dimension.

Appending transformations such as :names or :parents may change the indexes of dimensions.

name string

The name of the dimension.

It must be unique within the metric.

type string

The type of the dimension.

The MetricStatistic object

The default aggregation of a metric.

Element Type Description
parameter number

Specified which percentile of the metric should be delivered.

Applicable only to the PERCENTILE aggregation type.

Valid values for percentile are between 0 and 100.

type string

The type of default aggregation.