Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K

    Using the API

    Features overviewClient SDKsBeta headersErrors
    Messages
    Create a Message
    Count tokens in a Message
    Batches
    Create a Message Batch
    Retrieve a Message Batch
    List Message Batches
    Cancel a Message Batch
    Delete a Message Batch
    Retrieve Message Batch results
    Models
    List Models
    Get a Model
    Beta
    Models
    List Models
    Get a Model
    Messages
    Create a Message
    Count tokens in a Message
    Batches
    Create a Message Batch
    Retrieve a Message Batch
    List Message Batches
    Cancel a Message Batch
    Delete a Message Batch
    Retrieve Message Batch results
    Files
    Upload File
    List Files
    Download File
    Get File Metadata
    Delete File
    Skills
    Create Skill
    List Skills
    Get Skill
    Delete Skill
    Versions
    Create Skill Version
    List Skill Versions
    Get Skill Version
    Delete Skill Version
    Admin
    Organizations
    Get Current Organization
    Invites
    Create Invite
    Get Invite
    List Invites
    Delete Invite
    Users
    Get User
    List Users
    Update User
    Remove User
    Workspaces
    Create Workspace
    Get Workspace
    List Workspaces
    Update Workspace
    Archive Workspace
    Members
    Create Workspace Member
    Get Workspace Member
    List Workspace Members
    Update Workspace Member
    Delete Workspace Member
    API Keys
    Get Api Key
    List Api Keys
    Update Api Key
    Usage Report
    Get Messages Usage Report
    Get Claude Code Usage Report
    Cost Report
    Get Cost Report
    Completions
    Create a Text Completion

    Support & configuration

    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console
    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).

    maximum1000
    minimum1
    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"
    Accepts one of the following:
    "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"
    Accepts one of the following:
    "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.

    formatdate-time
    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
    curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \
        -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
    {
      "data": [
        {
          "actor": {
            "email_address": "[email protected]",
            "type": "user_actor"
          },
          "core_metrics": {
            "commits_by_claude_code": 8,
            "lines_of_code": {
              "added": 342,
              "removed": 128
            },
            "num_sessions": 15,
            "pull_requests_by_claude_code": 2
          },
          "customer_type": "api",
          "date": "2025-08-08T00:00:00Z",
          "model_breakdown": [
            {
              "estimated_cost": {
                "amount": 186,
                "currency": "USD"
              },
              "model": "claude-sonnet-4-20250514",
              "tokens": {
                "cache_creation": 2340,
                "cache_read": 8790,
                "input": 45230,
                "output": 12450
              }
            },
            {
              "estimated_cost": {
                "amount": 42,
                "currency": "USD"
              },
              "model": "claude-3-5-haiku-20241022",
              "tokens": {
                "cache_creation": 890,
                "cache_read": 3420,
                "input": 23100,
                "output": 5680
              }
            }
          ],
          "organization_id": "12345678-1234-5678-1234-567812345678",
          "terminal_type": "iTerm.app",
          "tool_actions": {
            "edit_tool": {
              "accepted": 25,
              "rejected": 3
            },
            "multi_edit_tool": {
              "accepted": 12,
              "rejected": 1
            },
            "notebook_edit_tool": {
              "accepted": 5,
              "rejected": 2
            },
            "write_tool": {
              "accepted": 8,
              "rejected": 0
            }
          },
          "subscription_type": "enterprise"
        }
      ],
      "has_more": true,
      "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
    }
    Returns Examples
    {
      "data": [
        {
          "actor": {
            "email_address": "[email protected]",
            "type": "user_actor"
          },
          "core_metrics": {
            "commits_by_claude_code": 8,
            "lines_of_code": {
              "added": 342,
              "removed": 128
            },
            "num_sessions": 15,
            "pull_requests_by_claude_code": 2
          },
          "customer_type": "api",
          "date": "2025-08-08T00:00:00Z",
          "model_breakdown": [
            {
              "estimated_cost": {
                "amount": 186,
                "currency": "USD"
              },
              "model": "claude-sonnet-4-20250514",
              "tokens": {
                "cache_creation": 2340,
                "cache_read": 8790,
                "input": 45230,
                "output": 12450
              }
            },
            {
              "estimated_cost": {
                "amount": 42,
                "currency": "USD"
              },
              "model": "claude-3-5-haiku-20241022",
              "tokens": {
                "cache_creation": 890,
                "cache_read": 3420,
                "input": 23100,
                "output": 5680
              }
            }
          ],
          "organization_id": "12345678-1234-5678-1234-567812345678",
          "terminal_type": "iTerm.app",
          "tool_actions": {
            "edit_tool": {
              "accepted": 25,
              "rejected": 3
            },
            "multi_edit_tool": {
              "accepted": 12,
              "rejected": 1
            },
            "notebook_edit_tool": {
              "accepted": 5,
              "rejected": 2
            },
            "write_tool": {
              "accepted": 8,
              "rejected": 0
            }
          },
          "subscription_type": "enterprise"
        }
      ],
      "has_more": true,
      "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
    }
    © 2025 ANTHROPIC PBC

    Products

    • Claude
    • Claude Code
    • Max plan
    • Team plan
    • Enterprise plan
    • Download app
    • Pricing
    • Log in

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Claude Developer Platform

    • Overview
    • Developer docs
    • Pricing
    • Amazon Bedrock
    • Google Cloud’s Vertex AI
    • Console login

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy

    Products

    • Claude
    • Claude Code
    • Max plan
    • Team plan
    • Enterprise plan
    • Download app
    • Pricing
    • Log in

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Claude Developer Platform

    • Overview
    • Developer docs
    • Pricing
    • Amazon Bedrock
    • Google Cloud’s Vertex AI
    • Console login

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy
    © 2025 ANTHROPIC PBC