Get Claude Code Usage Report

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 ParametersExpand Collapse

starting_at: string

UTC date in YYYY-MM-DD format. Returns metrics for this single day only.

limit: optional number

Number of records per page (default: 20, max: 1000).

page: optional string

Opaque cursor token from previous response's next_page field.

ReturnsExpand Collapse

ClaudeCodeUsageReport = object { data, has_more, next_page }

data: array of object { actor, core_metrics, customer_type, 6 more }

List of Claude Code usage records for the requested date.

actor: object { email_address, type } or object { api_key_name, type }

The user or API key that performed the Claude Code actions.

Accepts one of the following:

UserActor = object { email_address, type }

email_address: string

Email address of the user who performed Claude Code actions.

type: "user_actor"

APIActor = object { api_key_name, type }

api_key_name: string

Name of the API key used to perform Claude Code actions.

type: "api_actor"

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

Number of git commits created through Claude Code's commit functionality.

lines_of_code: object { added, removed }

Statistics on code changes made through Claude Code.

added: number

Total number of lines of code added across all files by Claude Code.

removed: number

Total number of lines of code removed across all files by Claude Code.

num_sessions: number

Number of distinct Claude Code sessions initiated by this actor.

pull_requests_by_claude_code: number

Number of pull requests created through Claude Code's PR functionality.

customer_type: "api" or "subscription"

Type of customer account (api for API customers, subscription for Pro/Team customers).

Accepts one of the following:

"api"

"subscription"

date: string

UTC date for the usage metrics in YYYY-MM-DD format.

model_breakdown: array of object { estimated_cost, model, tokens }

Token usage and cost breakdown by AI model used.

estimated_cost: object { amount, currency }

Estimated cost for using this model

amount: number

Estimated cost amount in minor currency units (e.g., cents for USD).

currency: string

Currency code for the estimated cost (e.g., 'USD').

model: string

Name of the AI model used for Claude Code interactions.

tokens: object { cache_creation, cache_read, input, output }

Token usage breakdown for this model

cache_creation: number

Number of cache creation tokens consumed by this model.

cache_read: number

Number of cache read tokens consumed by this model.

input: number

Number of input tokens consumed by this model.

output: number

Number of output tokens generated by this model.

organization_id: string

ID of the organization that owns the Claude Code usage.

terminal_type: string

Type of terminal or environment where Claude Code was used.

tool_actions: map[object { accepted, rejected } ]

Breakdown of tool action acceptance and rejection rates by tool type.

accepted: number

Number of tool action proposals that the user accepted.

rejected: number

Number of tool action proposals that the user rejected.

subscription_type: optional "enterprise" or "team"

Subscription tier for subscription customers. null for API customers.

Accepts one of the following:

"enterprise"

"team"

has_more: boolean

True if there are more records available beyond the current page.

next_page: string

Opaque cursor token for fetching the next page of results, or null if no more pages are available.

Get Claude Code Usage Report

curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

Returns Examples

Get Claude Code Usage Report

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 ParametersExpand Collapse

starting_at: string

UTC date in YYYY-MM-DD format. Returns metrics for this single day only.

limit: optional number

Number of records per page (default: 20, max: 1000).

page: optional string

Opaque cursor token from previous response's next_page field.

ReturnsExpand Collapse

ClaudeCodeUsageReport = object { data, has_more, next_page }

data: array of object { actor, core_metrics, customer_type, 6 more }

List of Claude Code usage records for the requested date.

actor: object { email_address, type } or object { api_key_name, type }

The user or API key that performed the Claude Code actions.

Accepts one of the following:

UserActor = object { email_address, type }

email_address: string

Email address of the user who performed Claude Code actions.

type: "user_actor"

APIActor = object { api_key_name, type }

api_key_name: string

Name of the API key used to perform Claude Code actions.

type: "api_actor"

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

Number of git commits created through Claude Code's commit functionality.

lines_of_code: object { added, removed }

Statistics on code changes made through Claude Code.

added: number

Total number of lines of code added across all files by Claude Code.

removed: number

Total number of lines of code removed across all files by Claude Code.

num_sessions: number

Number of distinct Claude Code sessions initiated by this actor.

pull_requests_by_claude_code: number

Number of pull requests created through Claude Code's PR functionality.

customer_type: "api" or "subscription"

Type of customer account (api for API customers, subscription for Pro/Team customers).

Accepts one of the following:

"api"

"subscription"

date: string

UTC date for the usage metrics in YYYY-MM-DD format.

model_breakdown: array of object { estimated_cost, model, tokens }

Token usage and cost breakdown by AI model used.

estimated_cost: object { amount, currency }

Estimated cost for using this model

amount: number

Estimated cost amount in minor currency units (e.g., cents for USD).

currency: string

Currency code for the estimated cost (e.g., 'USD').

model: string

Name of the AI model used for Claude Code interactions.

tokens: object { cache_creation, cache_read, input, output }

Token usage breakdown for this model

cache_creation: number

Number of cache creation tokens consumed by this model.

cache_read: number

Number of cache read tokens consumed by this model.

input: number

Number of input tokens consumed by this model.

output: number

Number of output tokens generated by this model.

organization_id: string

ID of the organization that owns the Claude Code usage.

terminal_type: string

Type of terminal or environment where Claude Code was used.

tool_actions: map[object { accepted, rejected } ]

Breakdown of tool action acceptance and rejection rates by tool type.

accepted: number

Number of tool action proposals that the user accepted.

rejected: number

Number of tool action proposals that the user rejected.

subscription_type: optional "enterprise" or "team"

Subscription tier for subscription customers. null for API customers.

Accepts one of the following:

"enterprise"

"team"

has_more: boolean

True if there are more records available beyond the current page.

next_page: string

Opaque cursor token for fetching the next page of results, or null if no more pages are available.

Get Claude Code Usage Report

curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"