Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Metrics

Edit metric metadata

Edit metadata of a specific metric. Find out more about supported types.

put/api/v1/metrics/{metric_name}

Path parameters

metric_namestring required

Name of the metric for which to edit metadata.

Request body

descriptionstring

Metric description.

integrationstring

Name of the integration that sent the metric if applicable.

per_unitstring

Per unit of the metric such as second in bytes per second.

short_namestring

A more human-readable and abbreviated version of the metric name.

statsd_intervalinteger

StatsD flush interval of the metric in seconds if applicable.

typestring

Metric type such as gauge or rate.

unitstring

Primary unit of the metric such as byte or operation.

Example request

{
  "per_unit": "second",
  "type": "count",
  "unit": "byte"
}

Response

OK

descriptionstring

Metric description.

integrationstring

Name of the integration that sent the metric if applicable.

per_unitstring

Per unit of the metric such as second in bytes per second.

short_namestring

A more human-readable and abbreviated version of the metric name.

statsd_intervalinteger

StatsD flush interval of the metric in seconds if applicable.

typestring

Metric type such as gauge or rate.

unitstring

Primary unit of the metric such as byte or operation.

Example response

{
  "per_unit": "second",
  "type": "count",
  "unit": "byte"
}