For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/cloud-cost-management/get-commitments-utilization-timeseries.md. A documentation index is available at /llms.txt.
Language
Datadog site

Get commitments utilization (timeseries)

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
GEThttps://api.datadoghq.com/api/v2/cost/commitments/utilization/timeserieshttps://api.us3.datadoghq.com/api/v2/cost/commitments/utilization/timeserieshttps://api.us5.datadoghq.com/api/v2/cost/commitments/utilization/timeserieshttps://api.datadoghq.eu/api/v2/cost/commitments/utilization/timeserieshttps://api.ap1.datadoghq.com/api/v2/cost/commitments/utilization/timeserieshttps://api.ap2.datadoghq.com/api/v2/cost/commitments/utilization/timeserieshttps://api.uk1.datadoghq.com/api/v2/cost/commitments/utilization/timeserieshttps://api.ddog-gov.com/api/v2/cost/commitments/utilization/timeserieshttps://api.us2.ddog-gov.com/api/v2/cost/commitments/utilization/timeseries

Overview

Get timeseries utilization metrics for cloud commitment programs, including used and unused cost series over time.

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
provider [required]
enum

Cloud provider for commitment programs (aws or azure).

Allowed enum values: aws, azure
product [required]
string

Cloud product identifier (for example, ec2, rds, virtualmachines).

start [required]
integer

Start of the query time range in Unix milliseconds.

end [required]
integer

End of the query time range in Unix milliseconds.

filterBy
string

Optional filter expression to narrow down results.

commitmentType
enum

Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Allowed enum values: ri, sp

Response

OK

Response containing timeseries utilization metrics for cloud commitment programs.

Field
Type
Description
series [required]
object

Timeseries data as a map of series names to their corresponding value arrays.

times [required]
[integer]

Unix timestamps in seconds for the timeseries data points.

unit
object

Unit metadata for a numeric metric.

Code Example

# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# 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/cost/commitments/utilization/timeseries?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"