List metric types

GET

/metric-types

const url = 'https://example.com/api/v1/metric-types';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/metric-types

Lists every registered metric type (official and custom). The catalog is fleet-wide reference data. Gated by metric_type:read.

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

metric_types

required

Array<object> | null

object

$schema

A URL to the JSON Schema for this object.

string format: uri

data_type

required

string

description

string

required

The metric type’s uuid, the stable form the contract and telemetry keys store

string

label

string

name

required

string

official

required

boolean

precision

Decimal places a rendered value keeps

integer format: int64

unit

The display unit of the series (ms, dB, percent)

string

Example

{
  "$schema": "/api/v1/schemas/ListMetricTypesOutputBody.json",
  "metric_types": [
    {
      "$schema": "/api/v1/schemas/MetricTypeBody.json"
    }
  ]
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}