For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/fr/api/latest/cloud-cost-management/get-commitments-savings-timeseries.md. A documentation index is available at /llms.txt.
Language
Datadog site

Get commitments savings (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/savings/timeserieshttps://api.us3.datadoghq.com/api/v2/cost/commitments/savings/timeserieshttps://api.us5.datadoghq.com/api/v2/cost/commitments/savings/timeserieshttps://api.datadoghq.eu/api/v2/cost/commitments/savings/timeserieshttps://api.ap1.datadoghq.com/api/v2/cost/commitments/savings/timeserieshttps://api.ap2.datadoghq.com/api/v2/cost/commitments/savings/timeserieshttps://api.uk1.datadoghq.com/api/v2/cost/commitments/savings/timeserieshttps://api.ddog-gov.com/api/v2/cost/commitments/savings/timeserieshttps://api.us2.ddog-gov.com/api/v2/cost/commitments/savings/timeseries

Présentation

Get timeseries savings metrics for cloud commitment programs, including actual cost, on-demand equivalent cost, realized savings, and effective savings rate 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

Chaînes de requête

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.

Réponse

OK

Response containing timeseries savings metrics for cloud commitment programs.

Champ
Type
Description
actual_cost [required]
object

A timeseries metric containing timestamps, series values, and optional unit metadata.

effective_savings_rate [required]
object

A timeseries metric containing timestamps, series values, and optional unit metadata.

on_demand_equivalent_cost [required]
object

A timeseries metric containing timestamps, series values, and optional unit metadata.

realized_savings [required]
object

A timeseries metric containing timestamps, series values, and optional unit metadata.

Exemple de code

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