v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBGet a list of metrics
Get a list of actively reporting metrics for your organization. Pagination is optional using the page[cursor] and page[size] query parameters.
Query parameters use bracket notation (for example, filter[tags], filter[queried][window][seconds]). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example: GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500.
Query parameters
Only return custom metrics that have been configured (true) or not configured (false) with Metrics Without Limits.
Only return metrics that are eligible (true) or ineligible (false) for configuration with Metrics Without Limits.
Tag keys to filter by.
Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
The metric's type category.
Only return metrics of the given metric type.
Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with filter[queried][window][seconds]; if omitted, a default window is used.
This parameter has no effect unless filter[queried] is also set. Only return metrics that have been queried or not queried in the specified window. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second. For example: filter[queried]=true&filter[queried][window][seconds]=604800.
Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards. For example: filter[tags]=env IN (staging,test) AND service:web*.
Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
Include related resources in the response. Set to metric_volumes to include indexed and ingested volume counts for each metric.
Sort results by metric volume. Prefix a key with - for descending order. Supported keys: metric_volumes.indexed_volume, metric_volumes.ingested_volume, metric_volumes.indexed_volume_delta, metric_volumes.ingested_volume_delta. Requires a paginated request (page[size] or page[cursor]).
Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
Maximum number of results per page. Send page[size] on the first request to opt in to pagination. On each subsequent request, send page[cursor] set to the value of meta.pagination.next_cursor from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
Cursor for pagination. Use page[size] to opt-in to pagination and get the first page; for subsequent pages, use the value from meta.pagination.next_cursor in the response. Pagination is complete when next_cursor is null.
Response
Success
Example response
{
"data": [
{
"id": "metric.foo.bar",
"type": "metrics"
}
],
"included": [
{
"attributes": {
"indexed_volume": 10,
"ingested_volume": 20
},
"id": "test.metric.latency",
"type": "metric_volumes"
}
],
"meta": {
"pagination": {
"type": "cursor_limit"
}
}
}