List tag indexing rule exemptions
https://api.datadoghq.com/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.us3.datadoghq.com/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.us5.datadoghq.com/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.datadoghq.eu/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.ap1.datadoghq.com/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.ap2.datadoghq.com/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.uk1.datadoghq.com/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.ddog-gov.com/api/v2/metrics/list-tag-indexing-rule-exemptionshttps://api.us2.ddog-gov.com/api/v2/metrics/list-tag-indexing-rule-exemptionsOverview
Returns explicit exemptions and legacy tag configurations that exclude metrics from tag indexing rules. You can filter results by metric name prefix, whether an exemption is safe to remove, or the UUID of a matching tag indexing rule. You can sort results by metric name or by estimated change in indexed volume.
OAuth apps require the metrics_read authorization scope to access this endpoint.
Arguments
Query Strings
filter[metric_prefix]Filter exemptions to metrics whose names start with this literal prefix. Matching is case-sensitive. Wildcard characters are treated literally.
filter[safe]Filter exemptions by whether they are safe to remove. An exemption is considered safe when a fresh, usable
estimate indicates that removing it would not increase indexed volume and would not drop tags used to query
the metric in monitors, dashboards, notebooks, or SLOs. Set to true to return safe-to-remove exemptions,
or false to return all other exemptions, including those with unavailable or stale estimates.
filter[tag_indexing_rule_id]Filter exemptions to metrics matched by the tag indexing rule with this UUID.
sortSort field. Prefix the field with - for descending order. The default is estimated_change_in_volume in ascending order, with the largest reductions (most negative values) first.
estimated_change_in_volumename, -name, estimated_change_in_volume, -estimated_change_in_volumepage[size]Maximum number of results per page. Defaults to 10000; accepts values from 1 to 10000. If
meta.pagination.next_cursor is non-null, request the next page by passing that value as page[cursor].
Continue until next_cursor is null.
10000page[cursor]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
OK
Response containing a page of tag indexing rule exemptions.
dataArray of tag indexing rule exemption objects.
attributesAttributes of a tag indexing rule exemption.
created_atTimestamp when the exemption was created.
created_by_handleHandle of the user who created the exemption.
estimated_change_in_volumeEstimated change in indexed cardinality or points if the exemption is removed and the matching tag indexing
rule applies to the metric. A negative value indicates a reduction in indexed volume, a positive value
indicates an increase, and zero indicates no change. A null value indicates that the estimate is unavailable.
kindDiscriminates between an explicit exemption (exemption) and a pre-existing legacy tag configuration acting as an implicit exclusion (legacy_tag_configuration).
missing_indexed_tagsTag keys used to query this metric in monitors, dashboards, notebooks, and SLOs that the matching rule would remove or not include if the exemption is removed.
reasonThe reason the metric is exempt from tag indexing rules.
volume_statusIndicates whether estimated_change_in_volume is available and, if not, why. ok indicates a fresh estimate.
unindexed_tags indicates that the matching rule uses tags that are not indexed for the metric.
unavailable indicates that the estimate is stale, was not computed, or could not be retrieved.
ok, unindexed_tags, unavailableidThe metric name, used as the resource ID.
typeThe tag indexing rule exemption resource type.
tag_indexing_rule_exemptionstag_indexing_rule_exemptionslinksPagination links. Only present if pagination query parameters were provided.
firstLink to the first page.
lastLink to the last page.
nextLink to the next page.
prevLink to previous page.
selfLink to current page.
metaResponse metadata object.
paginationPaging attributes. Only present if pagination query parameters were provided.
cursorThe cursor used to get the current results, if any.
limitNumber of results returned
next_cursorThe cursor used to get the next results, if any.
typeType of metric pagination.
cursor_limitcursor_limit{
"data": [
{
"attributes": {
"created_at": "2024-01-15T12:00:00.000Z",
"created_by_handle": "user@datadoghq.com",
"estimated_change_in_volume": 45,
"kind": "exemption",
"missing_indexed_tags": [
"service"
],
"reason": "This metric has a pre-existing tag configuration.",
"volume_status": "unavailable"
},
"id": "dd.test.metric",
"type": "tag_indexing_rule_exemptions"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"prev": "string",
"self": "string"
},
"meta": {
"pagination": {
"cursor": "string",
"limit": "integer",
"next_cursor": "string",
"type": "cursor_limit"
}
}
}Bad Request
API error response.
errors [required]A list of errors.
detailA human-readable explanation specific to this occurrence of the error.
metaNon-standard meta-information about the error
sourceReferences to the source of the error.
headerA string indicating the name of a single request header which caused the error.
parameterA string indicating which URI query parameter caused the error.
pointerA JSON pointer to the value in the request document that caused the error.
statusStatus code of the response.
titleShort human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Forbidden
API error response.
errors [required]A list of errors.
detailA human-readable explanation specific to this occurrence of the error.
metaNon-standard meta-information about the error
sourceReferences to the source of the error.
headerA string indicating the name of a single request header which caused the error.
parameterA string indicating which URI query parameter caused the error.
pointerA JSON pointer to the value in the request document that caused the error.
statusStatus code of the response.
titleShort human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too Many Requests
API error response.
errors [required]A list of errors.
detailA human-readable explanation specific to this occurrence of the error.
metaNon-standard meta-information about the error
sourceReferences to the source of the error.
headerA string indicating the name of a single request header which caused the error.
parameterA string indicating which URI query parameter caused the error.
pointerA JSON pointer to the value in the request document that caused the error.
statusStatus code of the response.
titleShort human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Code Example
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/metrics/list-tag-indexing-rule-exemptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"