provider Metrics GET
/api/v2/metrics @utdk/datadog
/api/v2/metrics Get 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.
- filter[configured] query
- Only return custom metrics that have been configured with Metrics Without Limits.
- boolean
- filter[tags_configured] query
- Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
- string
- filter[metric_type] query
- Only return metrics of the given metric type.
- enum: non_distribution, distribution
- filter[include_percentiles] query
- Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
- boolean
- filter[queried] query
- 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.
- boolean
- filter[queried][window][seconds] query
- Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with `filter[queried]`. 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.
- integer
- filter[tags] query
- Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
- string
- filter[related_assets] query
- Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
- boolean
- window[seconds] query
- 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.
- integer
- page[size] query
- Maximum number of results per page. Use with `page[cursor]` for pagination. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
- integer
- page[cursor] query
- 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.
- string
Try it
Authentication
Configure credentials for Datadog API V2 Collection
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import datadog from '@utdk/datadog';
await datadog.listtagconfigurations({
"filter[metric_type]": "distribution",
"filter[queried][window][seconds]": 2592000,
"window[seconds]": 3600,
"page[size]": 10000
})