---
title: 사용량 요약에 사용 가능한 필드 가져오기
description: GET /api/v1/usage/summary가 3가지 응답 수준에서 반환하는 필드 이름을 나열합니다. 각 목록에는 데이터 엔드포인트가 내보내는 모든 키가 포함되어 있습니다. 여기에는 OpenAPI 사양에 선언된 형식화된 필드와 additionalProperties를 통해…
breadcrumbs: 문서 > API > 사용량 요약에 사용 가능한 필드 가져오기
---

> For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt).

# 사용량 요약에 사용 가능한 필드 가져오기

## v2 (latest)

| Datadog site      | API endpoint                                                            |
| ----------------- | ----------------------------------------------------------------------- |
| 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 |
| app.datadoghq.eu  | GET https://api.datadoghq.eu/api/v2/usage/summary/available_fields      |
| 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 |
| uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/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  |

### Overview

`GET /api/v1/usage/summary`가 3가지 응답 수준에서 반환하는
필드 이름을 나열합니다. 각 목록에는 데이터 엔드포인트가 내보내는 모든 키가
포함되어 있습니다. 여기에는 OpenAPI 사양에 선언된 형식화된 필드와 `additionalProperties`를 통해
노출된 형식화되지 않은 키가 모두 포함됩니다(후자는 v1
스키마 고정 이후 추가된 청구 차원 및 사용량 유형에 사용됨).

이 엔드포인트는 [상위 수준 조직](https://docs.datadoghq.com/account_management/multi_organization.md)에서만 액세스할 수 있습니다.

Go 예시:

```go
fields, _, err := api.GetUsageSummaryAvailableFields(ctx)
attr := fields.Data.GetAttributes()

// resp는 api.GetUsageSummary(ctx, ...)에서 반환된 *UsageSummaryResponse입니다.
// 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://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ko/api/latest/scopes.md#usage-metering) to access this endpoint.

### Response

{% tabs %}
{% tab label="200" %}
OK.

{% tabs %}
{% tab label="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`. Default: `usage_summary_available_fields`.                                                                                                                                    |
{% /tab %}

{% tab label="Example" %}
```json
{
  "data": {
    "attributes": {
      "date_fields": [],
      "date_org_fields": [],
      "response_fields": []
    },
    "id": "all",
    "type": "string"
  }
}
```
{% /tab %}
{% /tabs %}
{% /tab %}

{% tab label="403" %}
Forbidden - User is not authorized.

{% tabs %}
{% tab label="Model" %}
API error response.

| Field               | Type     | Description       |
| ------------------- | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |
{% /tab %}

{% tab label="Example" %}
```json
{
  "errors": [
    "Bad Request"
  ]
}
```
{% /tab %}
{% /tabs %}
{% /tab %}

{% tab label="429" %}
Too many requests.

{% tabs %}
{% tab label="Model" %}
API error response.

| Field               | Type     | Description       |
| ------------------- | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |
{% /tab %}

{% tab label="Example" %}
```json
{
  "errors": [
    "Bad Request"
  ]
}
```
{% /tab %}
{% /tabs %}
{% /tab %}
{% /tabs %}

### Code Example

{% tabs %}
{% tab label="Curl" %}
```bash
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, 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/usage/summary/available_fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
```
{% /tab %}

{% tab label="Go" %}
```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())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
```
{% /tab %}

{% tab label="Java" %}
```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();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
```
{% /tab %}

{% tab label="Python" %}
```python
"""
Get available fields for usage summary returns "OK." response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
```
{% /tab %}

{% tab label="Ruby" %}
```ruby
# Get available fields for usage summary returns "OK." response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
p api_instance.get_usage_summary_available_fields()
```

#### Instructions

First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"
```
{% /tab %}

{% tab label="Rust" %}
```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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
```
{% /tab %}

{% tab label="TypeScript" %}
```typescript
/**
 * Get available fields for usage summary returns "OK." response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"
```
{% /tab %}
{% /tabs %}