Returns metric metadata

GET {{baseUrl}}/metadata

It returns metadata about metrics currently scrapped from targets. However, it does not provide any target information. This is considered experimental and might change in the future.

The data section of the query result consists of an object where each key is a metric name and each value is a list of unique metadata objects, as exposed for that metric name across all targets.

Request Params

KeyDatatypeRequiredDescription
limitnumber(Required) Maximum number of metrics to return.

Example: ?limit=2 | | metric | string | | A metric name to filter metadata for. All metric metadata is retrieved if left empty.

Example: ?metric=http_requests_total |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: Created

{"status":"success","data":{"http_requests_total":[{"type":"counter","help":"Number of HTTP requests","unit":""},{"type":"counter","help":"Amount of HTTP requests","unit":""}]}}