ListTagConfigurations
Retrieve and filter metrics with configured tags in Datadog, enabling precise control over metric tag configurations for observability and analytics.
Instructions
Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).
Optionally, paginate by using the page[cursor] and/or page[size] query parameters.
To fetch the first page, pass in a query parameter with either a valid page[size] or an empty cursor like page[cursor]=. To fetch the next page, pass in the next_cursor value from the response as the new page[cursor] value.
Once the meta.pagination.next_cursor value is null, all pages have been retrieved.
Query Parameters:
filter[configured]: Filter custom metrics that have configured tags.
filter[tags_configured]: Filter tag configurations by configured tags.
filter[metric_type]: Filter metrics by metric type.
filter[include_percentiles]: Filter distributions with additional percentile aggregations enabled or disabled.
filter[queried]: (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds]. If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
filter[tags]: Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Can only be combined with the filter[queried] filter.
filter[related_assets]: (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
window[seconds]: The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query. Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days).
page[size]: Maximum number of results returned.
page[cursor]: String to query the next page of results. This key is provided with each valid response from the API in
meta.pagination.next_cursor. Once themeta.pagination.next_cursorkey is null, all pages have been retrieved.
Responses:
200 (Success): Success
Content-Type:
application/jsonResponse Properties:
data: Array of metrics and metric tag configurations.
Example:
{
"data": [
"unknown_type"
],
"links": "unknown_type",
"meta": "unknown_type"
}400: Bad Request
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}403: Forbidden
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}429: Too Many Requests
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter[configured] | No | Filter custom metrics that have configured tags. | |
| filter[include_percentiles] | No | Filter distributions with additional percentile aggregations enabled or disabled. | |
| filter[metric_type] | No | The metric's type category. | distribution |
| filter[queried] | No | (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds]. If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied. | |
| filter[related_assets] | No | (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs. | |
| filter[tags] | No | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Can only be combined with the filter[queried] filter. | |
| filter[tags_configured] | No | Tag keys to filter by. | |
| page[cursor] | No | String to query the next page of results. This key is provided with each valid response from the API in `meta.pagination.next_cursor`. Once the `meta.pagination.next_cursor` key is null, all pages have been retrieved. | |
| page[size] | No | Maximum number of results returned. | |
| window[seconds] | No | The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query. Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Array of metrics and metric tag configurations. | |
| meta | No | ||
| links | No |