The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.
- 开发人员生产力分析: 跟踪使用 Claude Code 的会话、添加/删除的代码行数、提交和创建的拉取请求
- 工具使用指标: 监控不同 Claude Code 工具(Edit、Write、NotebookEdit)的接受和拒绝率
- 成本分析: 查看按 Claude 模型细分的估计成本和令牌使用情况
- 自定义报告: 导出数据以构建执行仪表板和管理团队报告
- 使用合理性: 提供指标以证明和内部扩展 Claude Code 采用
需要 Admin API 密钥此 API 是 Admin API 的一部分。这些端点需要与标准 API 密钥不同的 Admin API 密钥(以
sk-ant-admin... 开头)。只有具有管理员角色的组织成员才能通过 Claude Console 配置 Admin API 密钥。快速开始
获取您组织特定日期的 Claude Code 分析:为集成设置 User-Agent 标头如果您正在构建集成,请设置您的 User-Agent 标头以帮助我们了解使用模式:
Claude Code Analytics API
通过/v1/organizations/usage_report/claude_code 端点跟踪您组织中的 Claude Code 使用情况、生产力指标和开发人员活动。
关键概念
- 每日聚合:返回由
starting_at参数指定的单日指标 - 用户级数据:每条记录代表一个用户在指定日期的活动
- 生产力指标:跟踪会话、代码行数、提交、拉取请求和工具使用情况
- 令牌和成本数据:监控按 Claude 模型细分的使用情况和估计成本
- 基于游标的分页:使用不透明游标处理大型数据集的稳定分页
- 数据新鲜度:指标可在最多 1 小时延迟内获得以确保一致性
基本示例
获取特定日期的分析
获取带分页的分析
请求参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
starting_at | string | 是 | YYYY-MM-DD 格式的 UTC 日期。仅返回此单日的指标 |
limit | integer | 否 | 每页记录数(默认:20,最大:1000) |
page | string | 否 | 来自先前响应的 next_page 字段的不透明游标令牌 |
可用指标
每个响应记录包含单个用户在单日的以下指标:维度
- date:RFC 3339 格式的日期(UTC 时间戳)
- actor:执行 Claude Code 操作的用户或 API 密钥(带有
email_address的user_actor或带有api_key_name的api_actor) - organization_id:组织 UUID
- customer_type:客户账户类型(API 客户为
api,Pro/Team 客户为subscription) - terminal_type:使用 Claude Code 的终端或环境类型(例如,
vscode、iTerm.app、tmux)
核心指标
- num_sessions:此参与者发起的不同 Claude Code 会话数
- lines_of_code.added:Claude Code 在所有文件中添加的代码行总数
- lines_of_code.removed:Claude Code 在所有文件中删除的代码行总数
- commits_by_claude_code:通过 Claude Code 的提交功能创建的 git 提交数
- pull_requests_by_claude_code:通过 Claude Code 的 PR 功能创建的拉取请求数
工具操作指标
按工具类型细分的工具操作接受和拒绝率:- edit_tool.accepted/rejected:用户接受/拒绝的 Edit 工具提案数
- write_tool.accepted/rejected:用户接受/拒绝的 Write 工具提案数
- notebook_edit_tool.accepted/rejected:用户接受/拒绝的 NotebookEdit 工具提案数
模型细分
对于使用的每个 Claude 模型:- model:Claude 模型标识符(例如,
claude-3-5-sonnet-20241022) - tokens.input/output:此模型的输入和输出令牌计数
- tokens.cache_read/cache_creation:此模型的缓存相关令牌使用情况
- estimated_cost.amount:此模型的估计成本(美分 USD)
- estimated_cost.currency:成本金额的货币代码(目前始终为
USD)
响应结构
API 以以下格式返回数据:分页
API 支持基于游标的分页,适用于拥有大量用户的组织:- 使用可选的
limit参数进行初始请求 - 如果响应中的
has_more为true,请在下一个请求中使用next_page值 - 继续直到
has_more为false
常见用例
- 执行仪表板:创建显示 Claude Code 对开发速度影响的高级报告
- AI 工具比较:导出指标以将 Claude Code 与其他 AI 编码工具(如 Copilot 和 Cursor)进行比较
- 开发人员生产力分析:跟踪个人和团队随时间的生产力指标
- 成本跟踪和分配:监控支出模式并按团队或项目分配成本
- 采用监控:识别哪些团队和用户从 Claude Code 中获得最大价值
- ROI 合理性:提供具体指标以证明和内部扩展 Claude Code 采用
常见问题
分析数据有多新鲜?
Claude Code 分析数据通常在用户活动完成后 1 小时内出现。为确保一致的分页结果,响应中仅包含超过 1 小时的数据。我可以获得实时指标吗?
不可以,此 API 仅提供每日聚合指标。对于实时监控,请考虑使用 OpenTelemetry 集成。数据中如何识别用户?
用户通过actor 字段以两种方式识别:
user_actor:包含通过 OAuth 认证的用户的email_address(最常见)api_actor:包含通过 API 密钥认证的用户的api_key_name
customer_type 字段指示使用情况是来自 api 客户(API PAYG)还是 subscription 客户(Pro/Team 计划)。
数据保留期是多长?
历史 Claude Code 分析数据被保留并可通过 API 访问。此数据没有指定的删除期限。支持哪些 Claude Code 部署?
此 API 仅跟踪 Claude API(第一方)上的 Claude Code 使用情况。不包括在 Amazon Bedrock、Google Vertex AI 或其他第三方平台上的使用情况。使用此 API 的成本是多少?
Claude Code Analytics API 对所有有权访问 Admin API 的组织免费使用。如何计算工具接受率?
工具接受率 = 每种工具类型的accepted / (accepted + rejected)。例如,如果编辑工具显示 45 个接受和 5 个拒绝,则接受率为 90%。
日期参数使用什么时区?
所有日期都是 UTC。starting_at 参数应为 YYYY-MM-DD 格式,代表该日的 UTC 午夜。
另请参阅
Claude Code Analytics API 帮助您了解和优化团队的开发工作流程。了解更多相关功能:- Admin API 概述
- Admin API 参考
- Claude Code Analytics 仪表板
- 使用和成本 API - 跟踪所有 Anthropic 服务的 API 使用情况
- 身份和访问管理
- 使用 OpenTelemetry 监控使用情况 用于自定义指标和警报