GET https://api.ap1.datadoghq.com/api/v2/usage/billing_dimension_mapping https://api.ap2.datadoghq.com/api/v2/usage/billing_dimension_mapping https://api.datadoghq.eu/api/v2/usage/billing_dimension_mapping https://api.ddog-gov.com/api/v2/usage/billing_dimension_mapping https://api.us2.ddog-gov.com/api/v2/usage/billing_dimension_mapping https://api.datadoghq.com/api/v2/usage/billing_dimension_mapping https://api.us3.datadoghq.com/api/v2/usage/billing_dimension_mapping https://api.us5.datadoghq.com/api/v2/usage/billing_dimension_mapping
Overview
Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints.
Mapping data is updated on a monthly cadence.
This endpoint is only accessible to parent-level organizations .
This endpoint requires the
usage_read permission.
OAuth apps require the usage_read authorization scope to access this endpoint.
Arguments Query Strings Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month.
String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string active or all. Defaults to active.
Response OK
Billing dimensions mapping response.
Expand All
Billing dimensions mapping data.
Mapping of billing dimensions to endpoint keys.
List of supported endpoints with their keys mapped to the billing_dimension.
The URL for the endpoint.
Denotes whether mapping keys were available for this endpoint.
Allowed enum values: OK,NOT_FOUND
Label used for the billing dimension in the Plan & Usage charts.
Month in ISO-8601 format, UTC, and precise to the second: [YYYY-MM-DDThh:mm:ss].
ID of the billing dimension.
Type of active billing dimensions data.
Allowed enum values: billing_dimensions
default: billing_dimensions
{
"data" : [
{
"attributes" : {
"endpoints" : [
{
"id" : "api/v1/usage/billable-summary" ,
"keys" : [
"apm_host_top99p" ,
"apm_host_sum"
],
"status" : "string"
}
],
"in_app_label" : "APM Hosts" ,
"timestamp" : "2019-09-19T10:00:00.000Z"
},
"id" : "string" ,
"type" : "string"
}
]
} Bad Request
{
"errors" : [
"Bad Request"
]
} Forbidden - User is not authorized
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# 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/usage/billing_dimension_mapping " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Get billing dimension mapping for usage endpoints returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = UsageMeteringApi ( api_client )
response = api_instance . get_billing_dimension_mapping ()
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Get billing dimension mapping for usage endpoints returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: UsageMeteringAPI . new
p api_instance . get_billing_dimension_mapping ()
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Get billing dimension mapping for usage endpoints 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 . NewUsageMeteringApi ( apiClient )
resp , r , err := api . GetBillingDimensionMapping ( ctx , * datadogV2 . NewGetBillingDimensionMappingOptionalParameters ())
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `UsageMeteringApi.GetBillingDimensionMapping`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `UsageMeteringApi.GetBillingDimensionMapping`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Get billing dimension mapping for usage endpoints returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.UsageMeteringApi ;
import com.datadog.api.client.v2.model.BillingDimensionsMappingResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
UsageMeteringApi apiInstance = new UsageMeteringApi ( defaultClient );
try {
BillingDimensionsMappingResponse result = apiInstance . getBillingDimensionMapping ();
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling UsageMeteringApi#getBillingDimensionMapping" );
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 and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Get billing dimension mapping for usage endpoints returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_usage_metering ::GetBillingDimensionMappingOptionalParams ;
use datadog_api_client ::datadogV2 ::api_usage_metering ::UsageMeteringAPI ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = UsageMeteringAPI ::with_config ( configuration );
let resp = api
. get_billing_dimension_mapping ( GetBillingDimensionMappingOptionalParams ::default ())
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Get billing dimension mapping for usage endpoints returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . UsageMeteringApi ( configuration );
apiInstance
. getBillingDimensionMapping ()
. then (( data : v2.BillingDimensionsMappingResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"