--- title: List tag indexing rules description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Metrics --- # List tag indexing rules{% #list-tag-indexing-rules %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/metrics/tag-indexing-rules | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/metrics/tag-indexing-rules | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/metrics/tag-indexing-rules | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/metrics/tag-indexing-rules | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/metrics/tag-indexing-rules | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/metrics/tag-indexing-rules | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/metrics/tag-indexing-rules | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/metrics/tag-indexing-rules | ### Overview List tag indexing rules for an org, sorted by `rule_order`, with offset/limit pagination. This endpoint requires the `metrics_read` permission. OAuth apps require the `metrics_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#metrics) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | ------------ | ------- | --------------------------------------------------- | | page[limit] | integer | Page size (1–1000, default 100). | | page[offset] | integer | Page offset from the start of the list (default 0). | | search | string | Substring filter on rule name. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a page of tag indexing rules. | Parent field | Field | Type | Description | | ------------ | --------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | Array of tag indexing rule objects. | | data | attributes | object | Attributes of a tag indexing rule. | | attributes | created_at | date-time | Timestamp when the rule was created. | | attributes | created_by_handle | string | Handle of the user who created the rule. | | attributes | exclude_tags_mode | boolean | When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. | | attributes | ignored_metric_name_matches | [string] | Metric name prefixes excluded from the rule's scope. | | attributes | metric_name_matches | [string] | Metric name prefixes (glob patterns) this rule applies to. | | attributes | modified_at | date-time | Timestamp when the rule was last modified. | | attributes | modified_by_handle | string | Handle of the user who last modified the rule. | | attributes | name | string | Human-readable name for the rule. | | attributes | options | object | Versioned configuration options for a tag indexing rule. | | options | data | object | Data payload for tag indexing rule options. | | data | dynamic_tags | object | Configuration for including dynamically queried tags. | | dynamic_tags | queried_tags_window_seconds | int64 | Window in seconds for evaluating queried tags. | | dynamic_tags | related_asset_tags | boolean | When true, tags from related assets are included. | | data | manage_preexisting_metrics | boolean | When true, the rule applies to metrics that were ingested before the rule was created. | | data | metric_match | object | Criteria for matching metrics based on query state. | | metric_match | is_queried | boolean | Match metrics that are being queried. | | metric_match | not_queried | boolean | Match metrics that are not being queried. | | metric_match | not_used_in_assets | boolean | Match metrics not used in any dashboards or monitors. | | metric_match | queried_window_seconds | int64 | Window in seconds for evaluating query state. | | metric_match | used_in_assets | boolean | Match metrics used in dashboards or monitors. | | data | override_previous_rules | boolean | When true, this rule's tag list overrides tags configured by earlier rules for the same metric. When false (default), tags from all matching rules are combined. | | options | version | int64 | Options schema version. Only `1` is supported. | | attributes | rule_order | int64 | Evaluation order within the org. Lower values are evaluated first. Assigned server-side on create (max+1); pass on update to change the rule's position. | | attributes | tags | [string] | Tag keys managed by this rule. | | data | id | string | The unique identifier (UUID) of the tag indexing rule. | | data | type | enum | The tag indexing rule resource type. Allowed enum values: `tag_indexing_rules` | | | links | object | Pagination links. Only present if pagination query parameters were provided. | | links | first | string | Link to the first page. | | links | last | string | Link to the last page. | | links | next | string | Link to the next page. | | links | prev | string | Link to previous page. | | links | self | string | Link to current page. | | | meta | object | Pagination metadata for a list of tag indexing rules. | | meta | total | int64 | Total number of tag indexing rules in the org. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "created_at": "2024-01-15T12:00:00.000Z", "created_by_handle": "user@datadoghq.com", "exclude_tags_mode": false, "ignored_metric_name_matches": [ "dd.test.excluded.*" ], "metric_name_matches": [ "dd.test.*" ], "modified_at": "2024-01-15T12:00:00.000Z", "modified_by_handle": "user@datadoghq.com", "name": "my-indexing-rule", "options": { "data": { "dynamic_tags": { "queried_tags_window_seconds": 3600, "related_asset_tags": false }, "manage_preexisting_metrics": true, "metric_match": { "is_queried": false, "not_queried": false, "not_used_in_assets": false, "queried_window_seconds": 3600, "used_in_assets": false }, "override_previous_rules": false }, "version": 1 }, "rule_order": 1, "tags": [ "env", "service" ] }, "id": "00000000-0000-0000-0000-000000000001", "type": "tag_indexing_rules" } ], "links": { "first": "string", "last": "string", "next": "string", "prev": "string", "self": "string" }, "meta": { "total": 5 } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too Many Requests {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/metrics/tag-indexing-rules" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List tag indexing rules returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.metrics_api import MetricsApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.list_tag_indexing_rules() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # List tag indexing rules returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::MetricsAPI.new p api_instance.list_tag_indexing_rules() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // List tag indexing rules returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewMetricsApi(apiClient) resp, r, err := api.ListTagIndexingRules(ctx, *datadogV2.NewListTagIndexingRulesOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.ListTagIndexingRules`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.ListTagIndexingRules`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // List tag indexing rules returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.MetricsApi; import com.datadog.api.client.v2.model.TagIndexingRulesResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); MetricsApi apiInstance = new MetricsApi(defaultClient); try { TagIndexingRulesResponse result = apiInstance.listTagIndexingRules(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#listTagIndexingRules"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // List tag indexing rules returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_metrics::ListTagIndexingRulesOptionalParams; use datadog_api_client::datadogV2::api_metrics::MetricsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = MetricsAPI::with_config(configuration); let resp = api .list_tag_indexing_rules(ListTagIndexingRulesOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * List tag indexing rules returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.MetricsApi(configuration); apiInstance .listTagIndexingRules() .then((data: v2.TagIndexingRulesResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}