Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

List Cloud Cost Management tag key metadata

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/cost/tag_metadatahttps://api.ap2.datadoghq.com/api/v2/cost/tag_metadatahttps://api.datadoghq.eu/api/v2/cost/tag_metadatahttps://api.ddog-gov.com/api/v2/cost/tag_metadatahttps://api.us2.ddog-gov.com/api/v2/cost/tag_metadatahttps://api.datadoghq.com/api/v2/cost/tag_metadatahttps://api.us3.datadoghq.com/api/v2/cost/tag_metadatahttps://api.us5.datadoghq.com/api/v2/cost/tag_metadata

Overview

List Cloud Cost Management tag key metadata, including row counts, cost covered, cardinality, and a sample of top tag values per cloud account. Use filter[daily]=true to return daily rows instead of the default monthly roll-up. This endpoint requires the cloud_cost_management_read permission.

OAuth apps require the cloud_cost_management_read authorization scope to access this endpoint.

Arguments

Query Strings

Name

Type

Description

filter[month] [required]

string

The month to scope the query to, in YYYY-MM format.

filter[provider]

string

Filter results to a specific provider. Common cloud values are aws, azure, gcp, Oracle (OCI), and custom. SaaS billing integrations (for example, Snowflake, MongoDB, Databricks) are also accepted using their display-name string. Values are case-sensitive.

filter[metric]

string

Filter results to a specific Cloud Cost Management metric (for example, aws.cost.net.amortized). When omitted, every available metric for the requested period is returned.

filter[tag_key]

string

Restrict results to a single tag key.

filter[daily]

enum

When true, return one row per day with the day in the date attribute. Defaults to the monthly roll-up when omitted.
Allowed enum values: true, false

Response

OK

List of Cloud Cost Management tag key metadata entries for the requested period.

Expand All

Field

Type

Description

data [required]

[object]

List of tag key metadata entries.

attributes [required]

object

Attributes of a Cloud Cost Management tag key metadata entry.

cardinality_by_account [required]

object

Number of unique tag values observed for this tag key, keyed by cloud account ID.

<any-key>

int64

Number of unique tag values observed in the account.

cost_covered [required]

double

Total cost (in the report currency) of cost line items that carry this tag key for the requested period.

date

string

The day this row corresponds to, in YYYY-MM-DD format. Present only when filter[daily]=true; omitted for the monthly roll-up returned by default.

metric [required]

string

The Cloud Cost Management metric this row aggregates, for example aws.cost.net.amortized.

row_count [required]

int64

Number of cost rows that carry this tag key over the requested period.

tag_sources [required]

[string]

Origins where this tag key was observed (for example, aws-user-defined).

top_values_by_account [required]

object

A sample of the most frequent tag values observed for this tag key, keyed by cloud account ID.

<any-key>

[string]

A sample of the most frequent tag values observed in the account.

id [required]

string

A composite identifier of the form tag_key:metric for monthly roll-ups, or tag_key:metric:YYYY-MM-DD when filter[daily]=true.

type [required]

enum

Type of the Cloud Cost Management tag key metadata resource. Allowed enum values: cost_tag_key_metadata

default: cost_tag_key_metadata

{
  "data": [
    {
      "attributes": {
        "cardinality_by_account": {
          "123456789012": 42
        },
        "cost_covered": 1234.56,
        "metric": "aws.cost.net.amortized",
        "row_count": 100,
        "tag_sources": [
          "aws-user-defined"
        ],
        "top_values_by_account": {
          "123456789012": [
            "prod",
            "staging"
          ]
        }
      },
      "id": "env:aws.cost.net.amortized",
      "type": "cost_tag_key_metadata"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Required query arguments
export filter[month]="2026-02"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cost/tag_metadata?filter[month]=${filter[month]}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"