--- title: Get available fields for usage summary description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Usage Metering --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Get available fields for usage summary{% #get-available-fields-for-usage-summary %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/usage/summary/available_fields | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/usage/summary/available_fields | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/usage/summary/available_fields | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/usage/summary/available_fields | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/usage/summary/available_fields | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/usage/summary/available_fields | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/usage/summary/available_fields | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/usage/summary/available_fields | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/usage/summary/available_fields | ### Overview List the field names returned by `GET /api/v1/usage/summary` at each of its three response levels. Each list contains every key the data endpoint emits—both typed fields declared in the OpenAPI spec and untyped keys exposed through `additionalProperties` (the latter used for billing dimensions and usage types added after the v1 schema freeze). This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization.md). Go example: ```go fields, _, err := api.GetUsageSummaryAvailableFields(ctx) attr := fields.Data.GetAttributes() // resp is the *UsageSummaryResponse returned by api.GetUsageSummary(ctx, ...) // Layer 1: UsageSummaryResponse for _, key := range attr.GetResponseFields() { if val, ok := resp.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 2: UsageSummaryDate (per month) for _, date := range resp.GetUsage() { for _, key := range attr.GetDateFields() { if val, ok := date.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 3: UsageSummaryDateOrg (per org per month) for _, org := range date.GetOrgs() { for _, key := range attr.GetDateOrgFields() { if val, ok := org.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } } } ``` This endpoint requires the `usage_read` permission. OAuth apps require the `usage_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#usage-metering) to access this endpoint. ### Response {% tab title="200" %} OK. {% tab title="Model" %} Response listing every field name returned by `GET /api/v1/usage/summary` at each of its three response levels. Includes both typed fields and untyped `additionalProperties` keys. | Parent field | Field | Type | Description | | ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Available-fields data. | | data | attributes | object | The lists of field names returned by `GET /api/v1/usage/summary` at each of its three response levels. Each list contains every key the data endpoint emits—both typed fields declared in the OpenAPI spec and untyped keys exposed through `additionalProperties`. | | attributes | date_fields | [string] | Sorted list of every key returned inside each `UsageSummaryDate` entry of `usage[]` (typed fields and `additionalProperties` keys combined). | | attributes | date_org_fields | [string] | Sorted list of every key returned inside each `UsageSummaryDateOrg` entry of `usage[].orgs[]` (typed fields and `additionalProperties` keys combined). | | attributes | response_fields | [string] | Sorted list of every key returned as a direct property of `UsageSummaryResponse` (typed fields and `additionalProperties` keys combined). | | data | id | string | The identifier for the discovery scope. Always `"all"`. | | data | type | enum | Type of available-fields data. Allowed enum values: `usage_summary_available_fields` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "date_fields": [], "date_org_fields": [], "response_fields": [] }, "id": "all", "type": "string" } } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden - User is not authorized. {% 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 ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/usage/summary/available_fields" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get available fields for usage summary 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_usage_summary_available_fields() 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 # Get available fields for usage summary returns "OK." response require "datadog_api_client" api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new p api_instance.get_usage_summary_available_fields() ``` #### 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 // Get available fields for usage summary 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.GetUsageSummaryAvailableFields(ctx) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsageMeteringApi.GetUsageSummaryAvailableFields`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `UsageMeteringApi.GetUsageSummaryAvailableFields`:\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 // Get available fields for usage summary 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.UsageSummaryAvailableFieldsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); UsageMeteringApi apiInstance = new UsageMeteringApi(defaultClient); try { UsageSummaryAvailableFieldsResponse result = apiInstance.getUsageSummaryAvailableFields(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling UsageMeteringApi#getUsageSummaryAvailableFields"); 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 // Get available fields for usage summary returns "OK." response use datadog_api_client::datadog; 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_usage_summary_available_fields().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 /** * Get available fields for usage summary returns "OK." response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.UsageMeteringApi(configuration); apiInstance .getUsageSummaryAvailableFields() .then((data: v2.UsageSummaryAvailableFieldsResponse) => { 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 %}