Get Messages Usage Report

get/v1/organizations/usage_report/messages

Query ParametersExpand Collapse

starting_at: string

Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC.

formatdate-time

api_key_ids: optional array of string

Restrict usage returned to the specified API key ID(s).

bucket_width: optional "1d" or "1m" or "1h"

Time granularity of the response data.

Accepts one of the following:

"1d"

"1m"

"1h"

context_window: optional array of "0-200k" or "200k-1M"

Restrict usage returned to the specified context window(s).

Accepts one of the following:

"0-200k"

"200k-1M"

ending_at: optional string

Time buckets that end before this RFC 3339 timestamp will be returned.

formatdate-time

group_by: optional array of "api_key_id" or "workspace_id" or "model" or 2 more

Group by any subset of the available options.

Accepts one of the following:

"api_key_id"

"workspace_id"

"model"

"service_tier"

"context_window"

limit: optional number

Maximum number of time buckets to return in the response.

The default and max limits depend on bucket_width: • "1d": Default of 7 days, maximum of 31 days • "1h": Default of 24 hours, maximum of 168 hours • "1m": Default of 60 minutes, maximum of 1440 minutes

models: optional array of string

Restrict usage returned to the specified model(s).

page: optional string

Optionally set to the next_page token from the previous response.

formatdate-time

service_tiers: optional array of "standard" or "batch" or "priority" or 3 more

Restrict usage returned to the specified service tier(s).

Accepts one of the following:

"standard"

"batch"

"priority"

"priority_on_demand"

"flex"

"flex_discount"

workspace_ids: optional array of string

Restrict usage returned to the specified workspace ID(s).

ReturnsExpand Collapse

MessagesUsageReport = object { data, has_more, next_page }

data: array of object { ending_at, results, starting_at }

ending_at: string

End of the time bucket (exclusive) in RFC 3339 format.

formatdate-time

results: array of object { api_key_id, cache_creation, cache_read_input_tokens, 7 more }

List of usage items for this time bucket. There may be multiple items if one or more group_by[] parameters are specified.

api_key_id: string

ID of the API key used. Null if not grouping by API key or for usage in the Anthropic Console.

cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

The number of input tokens for cache creation.

ephemeral_1h_input_tokens: number

The number of input tokens used to create the 1 hour cache entry.

ephemeral_5m_input_tokens: number

The number of input tokens used to create the 5 minute cache entry.

cache_read_input_tokens: number

The number of input tokens read from the cache.

context_window: "0-200k" or "200k-1M"

Context window used. Null if not grouping by context window.

Accepts one of the following:

"0-200k"

"200k-1M"

model: string

Model used. Null if not grouping by model.

output_tokens: number

The number of output tokens generated.

server_tool_use: object { web_search_requests }

Server-side tool usage metrics.

web_search_requests: number

The number of web search requests made.

service_tier: "standard" or "batch" or "priority" or 3 more

Service tier used. Null if not grouping by service tier.

Accepts one of the following:

"standard"

"batch"

"priority"

"priority_on_demand"

"flex"

"flex_discount"

uncached_input_tokens: number

The number of uncached input tokens processed.

workspace_id: string

ID of the Workspace used. Null if not grouping by workspace or for the default workspace.

starting_at: string

Start of the time bucket (inclusive) in RFC 3339 format.

formatdate-time

has_more: boolean

Indicates if there are more results.

next_page: string

Token to provide in as page in the subsequent request to retrieve the next page of data.

formatdate-time

Get Messages Usage Report

curl https://api.anthropic.com/v1/organizations/usage_report/messages \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

Response 200

{
  "data": [
    {
      "ending_at": "2025-08-02T00:00:00Z",
      "results": [
        {
          "api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
          "cache_creation": {
            "ephemeral_1h_input_tokens": 1000,
            "ephemeral_5m_input_tokens": 500
          },
          "cache_read_input_tokens": 200,
          "context_window": "0-200k",
          "model": "claude-sonnet-4-20250514",
          "output_tokens": 500,
          "server_tool_use": {
            "web_search_requests": 10
          },
          "service_tier": "standard",
          "uncached_input_tokens": 1500,
          "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
        }
      ],
      "starting_at": "2025-08-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "2019-12-27T18:11:19.117Z"
}

Returns Examples

Response 200

{
  "data": [
    {
      "ending_at": "2025-08-02T00:00:00Z",
      "results": [
        {
          "api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
          "cache_creation": {
            "ephemeral_1h_input_tokens": 1000,
            "ephemeral_5m_input_tokens": 500
          },
          "cache_read_input_tokens": 200,
          "context_window": "0-200k",
          "model": "claude-sonnet-4-20250514",
          "output_tokens": 500,
          "server_tool_use": {
            "web_search_requests": 10
          },
          "service_tier": "standard",
          "uncached_input_tokens": 1500,
          "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
        }
      ],
      "starting_at": "2025-08-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "2019-12-27T18:11:19.117Z"
}

{ "data": [ { "ending_at": "2025-08-02T00:00:00Z", "results": [ { "api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "cache_creation": { "ephemeral_1h_input_tokens": 1000, "ephemeral_5m_input_tokens": 500 }, "cache_read_input_tokens": 200, "context_window": "0-200k", "model": "claude-sonnet-4-20250514", "output_tokens": 500, "server_tool_use": { "web_search_requests": 10 }, "service_tier": "standard", "uncached_input_tokens": 1500, "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "starting_at": "2025-08-01T00:00:00Z" } ], "has_more": true, "next_page": "2019-12-27T18:11:19.117Z" }