--- title: List tag configuration by name description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Metrics --- # List tag configuration by name{% #list-tag-configuration-by-name %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/metrics/{metric_name}/tags | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/metrics/{metric_name}/tags | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/metrics/{metric_name}/tags | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/metrics/{metric_name}/tags | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/metrics/{metric_name}/tags | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/metrics/{metric_name}/tags | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/metrics/{metric_name}/tags | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/metrics/{metric_name}/tags | ### Overview Returns the tag configuration for the given metric name. 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 #### Path Parameters | Name | Type | Description | | ----------------------------- | ------ | ----------------------- | | metric_name [*required*] | string | The name of the metric. | ### Response {% tab title="200" %} Success {% tab title="Model" %} Response object which includes a single metric's tag configuration. | Parent field | Field | Type | Description | | ------------ | ----------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Object for a single metric tag configuration. | | data | attributes | object | Object containing the definition of a metric tag configuration attributes. | | attributes | aggregations | [object] | Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits. | | aggregations | space [*required*] | enum | A space aggregation for use in query. Allowed enum values: `avg,max,min,sum` | | aggregations | time [*required*] | enum | A time aggregation for use in query. Allowed enum values: `avg,count,max,min,sum` | | attributes | created_at | date-time | Timestamp when the tag configuration was created. | | attributes | exclude_tags_mode | boolean | When set to true, the configuration will exclude the configured tags and include any other submitted tags. When set to false, the configuration will include the configured tags and exclude any other submitted tags. Defaults to false. Requires `tags` property. | | attributes | include_percentiles | boolean | Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. | | attributes | metric_type | enum | The metric's type. Allowed enum values: `gauge,count,rate,distribution` | | attributes | modified_at | date-time | Timestamp when the tag configuration was last modified. | | attributes | tags | [string] | List of tag keys on which to group. | | data | id | string | The metric name for this resource. | | data | type | enum | The metric tag configuration resource type. Allowed enum values: `manage_tags` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "aggregations": [ { "space": "sum", "time": "sum" } ], "created_at": "2020-03-25T09:48:37.463835Z", "exclude_tags_mode": false, "include_percentiles": true, "metric_type": "count", "modified_at": "2020-03-25T09:48:37.463835Z", "tags": [ "app", "datacenter" ] }, "id": "test.metric.latency", "type": "manage_tags" } } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too Many Requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export metric_name="dist.http.endpoint.request" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/metrics/${metric_name}/tags" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List tag configuration by name returns "Success" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.metrics_api import MetricsApi # there is a valid "metric_tag_configuration" in the system METRIC_TAG_CONFIGURATION_DATA_ID = environ["METRIC_TAG_CONFIGURATION_DATA_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.list_tag_configuration_by_name( metric_name=METRIC_TAG_CONFIGURATION_DATA_ID, ) 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 configuration by name returns "Success" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::MetricsAPI.new # there is a valid "metric_tag_configuration" in the system METRIC_TAG_CONFIGURATION_DATA_ID = ENV["METRIC_TAG_CONFIGURATION_DATA_ID"] p api_instance.list_tag_configuration_by_name(METRIC_TAG_CONFIGURATION_DATA_ID) ``` #### 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 configuration by name returns "Success" 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() { // there is a valid "metric_tag_configuration" in the system MetricTagConfigurationDataID := os.Getenv("METRIC_TAG_CONFIGURATION_DATA_ID") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewMetricsApi(apiClient) resp, r, err := api.ListTagConfigurationByName(ctx, MetricTagConfigurationDataID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.ListTagConfigurationByName`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.ListTagConfigurationByName`:\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 configuration by name returns "Success" 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.MetricTagConfigurationResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); MetricsApi apiInstance = new MetricsApi(defaultClient); // there is a valid "metric_tag_configuration" in the system String METRIC_TAG_CONFIGURATION_DATA_ID = System.getenv("METRIC_TAG_CONFIGURATION_DATA_ID"); try { MetricTagConfigurationResponse result = apiInstance.listTagConfigurationByName(METRIC_TAG_CONFIGURATION_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#listTagConfigurationByName"); 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 configuration by name returns "Success" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_metrics::MetricsAPI; #[tokio::main] async fn main() { // there is a valid "metric_tag_configuration" in the system let metric_tag_configuration_data_id = std::env::var("METRIC_TAG_CONFIGURATION_DATA_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = MetricsAPI::with_config(configuration); let resp = api .list_tag_configuration_by_name(metric_tag_configuration_data_id.clone()) .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 configuration by name returns "Success" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.MetricsApi(configuration); // there is a valid "metric_tag_configuration" in the system const METRIC_TAG_CONFIGURATION_DATA_ID = process.env .METRIC_TAG_CONFIGURATION_DATA_ID as string; const params: v2.MetricsApiListTagConfigurationByNameRequest = { metricName: METRIC_TAG_CONFIGURATION_DATA_ID, }; apiInstance .listTagConfigurationByName(params) .then((data: v2.MetricTagConfigurationResponse) => { 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 %}