One change

Usage Report

api/admin/usage_report

25 Aug 2026 03:37 UTC first seen 14 Aug 2026 The page's own history The capture it came from

Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.

api/admin/usage_report Changed · +68 / -59 lines

### Query parameters ### Headers #### Response (200) ### Query parameters #### Response (200) ## Domain types ### Query Parameters ### Header Parameters #### Response ### Query Parameters #### Response ## Domain Types

from line 1

----
-title: Usage Report
-url: https://platform.claude.com/docs/en/api/admin/usage_report
----
-
 # Usage Report
 
 ## Get Messages Usage Report
 
-**get** `/v1/organizations/usage_report/messages`
+**GET** `/v1/organizations/usage_report/messages`
 
 Get Messages Usage Report
 
-### Query Parameters
+### Query parameters
 
 - `starting_at: string`

from line 13

   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.
 
+  format: date-time
+
 - `account_ids: optional array of string`
 
   Restrict usage returned to the specified user account ID(s).

from line 27

 
   Time granularity of the response data.
 
+  default: 1d
+
   - `"1d"`
 
   - `"1h"`

from line 47

 
   Time buckets that end before this RFC 3339 timestamp will be returned.
 
+  format: date-time
+
 - `group_by: optional array of "account_id" or "api_key_id" or "context_window" or 6 more`
 
   Group by any subset of the available options. Grouping by `speed` requires the `fast-mode-2026-02-01` beta header.

from line 131

 
   Restrict usage returned to the specified workspace ID(s).
 
-### Header Parameters
+### Headers
 
 - `"anthropic-beta": optional array of string`

from line 141

 
 ### Returns
 
-- `MessagesUsageReport object { data, has_more, next_page }`
+- `MessagesUsageReport object`
 
-  - `data: array of object { ending_at, results, starting_at }`
+  - `data: array of object`
 
     List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no usage (their `results` list is empty). A page holds at most `limit` buckets.

from line 151

 
       End of the time bucket (exclusive) in RFC 3339 format.
 
-    - `results: array of object { account_id, api_key_id, cache_creation, 10 more }`
+      format: date-time
 
+    - `results: array of object`
+
       List of usage items for this time bucket.  There may be multiple items if one or more `group_by[]` parameters are specified.
 
       - `account_id: string or null`

from line 165

 
         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 }`
+      - `cache_creation: object`
 
         The number of input tokens for cache creation.

from line 208

 
         The number of output tokens generated.
 
-      - `server_tool_use: object { web_search_requests }`
+      - `server_tool_use: object`
 
         Server-side tool usage metrics.

from line 248

 
       Start of the time bucket (inclusive) in RFC 3339 format.
 
+      format: date-time
+
   - `has_more: boolean`
 
     Indicates if there are more results.

from line 260

 
 ### Example
 
-```http
+```bash
 curl https://api.anthropic.com/v1/organizations/usage_report/messages \
     -H 'anthropic-version: 2023-06-01' \
     -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
 ```
 
-#### Response
+#### Response (200)
 
 ```json
 {

from line 305

 
 ## Get Claude Code Usage Report
 
-**get** `/v1/organizations/usage_report/claude_code`
+**GET** `/v1/organizations/usage_report/claude_code`
 
 Retrieve daily aggregated usage metrics for Claude Code users.
 Enables organizations to analyze developer productivity and build custom dashboards.
 
-### Query Parameters
+### Query parameters
 
 - `starting_at: string`
 
   UTC date in YYYY-MM-DD format. Returns metrics for this single day only.
 
+  pattern: ^\d{4}-\d{2}-\d{2}$
+
 - `limit: optional number`
 
   Number of records per page (default: 20, max: 1000).
 
+  default: 20, maximum: 1000, minimum: 1
+
 - `page: optional string`
 
   Opaque cursor token from previous response's `next_page` field.

from line 330

 
 ### Returns
 
-- `ClaudeCodeUsageReport object { data, has_more, next_page }`
+- `ClaudeCodeUsageReport object`
 
-  - `data: array of object { actor, core_metrics, customer_type, 7 more }`
+  - `data: array of object`
 
     List of Claude Code usage records for the requested date.
 
-    - `actor: object { email_address, type }  or object { api_key_name, type }`
+    - `actor: object or object`
 
       The user or API key that performed the Claude Code actions.
 
-      - `UserActor object { email_address, type }`
+      - `UserActor object`
 
         - `email_address: string`

from line 350

 
           Actor type. Always `"user_actor"` for a user.
 
-          - `"user_actor"`
+      - `APIActor object`
 
-      - `APIActor object { api_key_name, type }`
-
         - `api_key_name: string`
 
           Name of the API key used to perform Claude Code actions.

from line 360

 
           Actor type. Always `"api_actor"` for an API key.
 
-          - `"api_actor"`
+    - `core_metrics: object`
 
-    - `core_metrics: object { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }`
-
       Core productivity metrics measuring Claude Code usage and impact.
 
       - `commits_by_claude_code: number`

from line 368

 
         Number of git commits created through Claude Code's commit functionality.
 
-      - `lines_of_code: object { added, removed }`
+      - `lines_of_code: object`
 
         Statistics on code changes made through Claude Code.

from line 401

       UTC day the usage metrics cover, as an RFC 3339 timestamp at midnight UTC
       (for example `2025-08-08T00:00:00Z`).
 
+      format: date-time
+
     - `is_remote: boolean`
 
       Whether the usage came from remote Claude Code sessions, such as Claude Code
       on the web. Remote and local usage are reported as separate rows.
 
-    - `model_breakdown: array of object { estimated_cost, model, tokens }`
+    - `model_breakdown: array of object`
 
       Token usage and cost breakdown by AI model used.
 
-      - `estimated_cost: object { amount, currency }`
+      - `estimated_cost: object`
 
         Estimated cost for using this model

from line 428

 
         Name of the AI model used for Claude Code interactions.
 
-      - `tokens: object { cache_creation, cache_read, input, output }`
+      - `tokens: object`
 
         Token usage breakdown for this model

from line 456

 
       Type of terminal or environment where Claude Code was used.
 
-    - `tool_actions: map[object { accepted, rejected } ]`
+    - `tool_actions: map[object]`
 
       Breakdown of tool action acceptance and rejection rates by tool type.

from line 486

 
 ### Example
 
-```http
+```bash
 curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \
     -H 'anthropic-version: 2023-06-01' \
     -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
 ```
 
-#### Response
+#### Response (200)
 
 ```json
 {

from line 570

 }
 ```
 
-## Domain Types
+## Domain types
 
 ### Claude Code Usage Report
 
-- `ClaudeCodeUsageReport object { data, has_more, next_page }`
+- `ClaudeCodeUsageReport object`
 
-  - `data: array of object { actor, core_metrics, customer_type, 7 more }`
+  - `data: array of object`
 
     List of Claude Code usage records for the requested date.
 
-    - `actor: object { email_address, type }  or object { api_key_name, type }`
+    - `actor: object or object`
 
       The user or API key that performed the Claude Code actions.
 
-      - `UserActor object { email_address, type }`
+      - `UserActor object`
 
         - `email_address: string`

from line 594

 
           Actor type. Always `"user_actor"` for a user.
 
-          - `"user_actor"`
+      - `APIActor object`
 
-      - `APIActor object { api_key_name, type }`
-
         - `api_key_name: string`
 
           Name of the API key used to perform Claude Code actions.

from line 604

 
           Actor type. Always `"api_actor"` for an API key.
 
-          - `"api_actor"`
+    - `core_metrics: object`
 
-    - `core_metrics: object { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }`
-
       Core productivity metrics measuring Claude Code usage and impact.
 
       - `commits_by_claude_code: number`

from line 612

 
         Number of git commits created through Claude Code's commit functionality.
 
-      - `lines_of_code: object { added, removed }`
+      - `lines_of_code: object`
 
         Statistics on code changes made through Claude Code.

from line 645

       UTC day the usage metrics cover, as an RFC 3339 timestamp at midnight UTC
       (for example `2025-08-08T00:00:00Z`).
 
+      format: date-time
+
     - `is_remote: boolean`
 
       Whether the usage came from remote Claude Code sessions, such as Claude Code
       on the web. Remote and local usage are reported as separate rows.
 
-    - `model_breakdown: array of object { estimated_cost, model, tokens }`
+    - `model_breakdown: array of object`
 
       Token usage and cost breakdown by AI model used.
 
-      - `estimated_cost: object { amount, currency }`
+      - `estimated_cost: object`
 
         Estimated cost for using this model

from line 672

 
         Name of the AI model used for Claude Code interactions.
 
-      - `tokens: object { cache_creation, cache_read, input, output }`
+      - `tokens: object`
 
         Token usage breakdown for this model

from line 700

 
       Type of terminal or environment where Claude Code was used.
 
-    - `tool_actions: map[object { accepted, rejected } ]`
+    - `tool_actions: map[object]`
 
       Breakdown of tool action acceptance and rejection rates by tool type.

from line 730

 
 ### Messages Usage Report
 
-- `MessagesUsageReport object { data, has_more, next_page }`
+- `MessagesUsageReport object`
 
-  - `data: array of object { ending_at, results, starting_at }`
+  - `data: array of object`
 
     List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no usage (their `results` list is empty). A page holds at most `limit` buckets.

from line 740

 
       End of the time bucket (exclusive) in RFC 3339 format.
 
-    - `results: array of object { account_id, api_key_id, cache_creation, 10 more }`
+      format: date-time
 
+    - `results: array of object`
+
       List of usage items for this time bucket.  There may be multiple items if one or more `group_by[]` parameters are specified.
 
       - `account_id: string or null`

from line 754

 
         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 }`
+      - `cache_creation: object`
 
         The number of input tokens for cache creation.

from line 797

 
         The number of output tokens generated.
 
-      - `server_tool_use: object { web_search_requests }`
+      - `server_tool_use: object`
 
         Server-side tool usage metrics.

from line 836

     - `starting_at: string`
 
       Start of the time bucket (inclusive) in RFC 3339 format.
+
+      format: date-time
 
   - `has_more: boolean`