Claude 企业分析 API 参考指南

概述

Claude 企业分析 API 为您的组织提供对企业组织内 Claude 和 Claude Code 使用情况的参与度数据的编程访问权限。无论您是为用户活动构建内部仪表板还是跟踪项目采用情况，此 API 都提供您所需的聚合指标。

数据聚合

所有数据都按每个组织、每天进行聚合。每个端点都返回您指定的单个日期的快照。第 (N-1) 天的数据在第 N 天的 10:00:00 UTC 时间运行，聚合后三天内可用于查询，以确保数据准确性。

如果数据在上述时间范围内不可用，这通常表示我们的团队需要在内部调查的数据管道故障。我们通常会意识到此类问题，但如果您想进行检查或怀疑有其他问题，请向您的 CSM 反映。

启用访问

为了生成新的分析 API 密钥，您必须是企业组织内的主要所有者。您可以通过导航到 claude.ai/analytics/api-keys 来完成此操作。

以下是一些可能有帮助的更多详情：

您可以随时启用/禁用对公共 API 的访问。如果您通过切换开关来禁用访问，所有请求都将被拒绝。
您需要具有 read:analytics 作用域的密钥才能访问 API。您可以为您的组织创建多个密钥，但速率限制适用于组织级别，而不是密钥级别。请参阅下面的"速率限制"部分。
一如既往，我们强烈建议安全地处理 API 密钥：切勿公开共享这些密钥 - 它们是机密的，应该安全地共享。

基础 URL

所有请求都发送到：

https://api.anthropic.com/v1/organizations/analytics/

身份验证

每个请求都需要在 x-api-key 标头中传递 API 密钥。您的 API 密钥必须具有 read:analytics 作用域。您可以从 claude.ai 管理员设置中的 API 密钥部分创建和管理 API 密钥。

示例请求标头：

x-api-key: $YOUR_API_KEY

分页

多个端点返回分页结果。分页使用基于游标的方法，其中响应包含一个 next_page 令牌，您在下一个请求中传回该令牌以检索结果的下一页。

两个可选参数控制分页：

limit（整数）：每页的记录数。/users 端点默认为 20，所有其他端点默认为 100。最大值为 1000。

page（字符串）：来自上一个响应的 next_page 字段的不透明游标令牌。在您的第一个请求中省略此项。

当没有更多结果时，响应中的 next_page 将为 null。

错误响应

所有端点都返回标准 HTTP 错误代码：

代码	含义
400	查询参数无效。常见原因包括日期无效、日期早于 1/1/26（首次可用）或日期为今天或未来。数据可用性延迟三天。
404	API 密钥缺失、无效或不具有 `read:analytics` 作用域。
429	超过速率限制。请求过多。
503	暂时性故障，请重试。

速率限制

我们确实有默认速率限制。如果这对您的用例不够，我们很想了解原因。如有必要，我们可以为您的组织调整速率限制 - 请与您的 CSM 联系。

端点

1. 列出用户活动

GET /v1/organizations/analytics/users

返回单个日期的每用户参与度指标。响应中的每一项代表一个用户，并包括他们在 Claude（聊天）和 Claude Code 中的活动计数。

查询参数

字段	类型	必需	描述
`date`	字符串	是	用于检索指标的日期，格式为 YYYY-MM-DD。
`limit`	整数	否	每页记录数（默认值：20，最大值：1000）。
`page`	字符串	否	来自上一个响应的游标令牌，位于 `next_page` 字段中，用于检索下一页。

响应字段（每个用户）

字段	描述
`user.id`	用户的唯一标识符。
`user.email_address`	用户的电子邮件地址。
`chat_metrics.distinct_conversation_count`	不同对话的数量，特别是在 Claude.ai 内。
`chat_metrics.message_count`	发送的总消息数，特别是在 Claude.ai 内。
`chat_metrics.distinct_projects_created_count`	创建的项目数，特别是在 Claude.ai 内。
`chat_metrics.distinct_projects_used_count`	使用的不同项目数，特别是在 Claude.ai 内。
`chat_metrics.distinct_files_uploaded_count`	上传的文件数，特别是在 Claude.ai 内。
`chat_metrics.distinct_artifacts_created_count`	创建的工件数，特别是在 Claude.ai 内。
`chat_metrics.thinking_message_count`	思考（扩展）消息的数量，特别是在 Claude.ai 内。
`chat_metrics.distinct_skills_used_count`	使用的不同技能数，特别是在 Claude.ai 内。
`chat_metrics.connectors_used_count`	调用的连接器总数，特别是在 Claude.ai 内。
`claude_code_metrics.core_metrics.commit_count`	通过 Claude Code 进行的 git 提交数。
`claude_code_metrics.core_metrics.pull_request_count`	通过 Claude Code 创建的拉取请求数。
`claude_code_metrics.core_metrics.lines_of_code.added_count`	添加的代码总行数。
`claude_code_metrics.core_metrics.lines_of_code.removed_count`	删除的代码总行数。
`claude_code_metrics.core_metrics.distinct_session_count`	不同 Claude Code 会话的数量。
`claude_code_metrics.tool_actions.edit_tool`	编辑工具的接受和拒绝计数。
`claude_code_metrics.tool_actions.multi_edit_tool`	多编辑工具的接受和拒绝计数。
`claude_code_metrics.tool_actions.write_tool`	写入工具的接受和拒绝计数。
`claude_code_metrics.tool_actions.notebook_edit_tool`	Notebook Edit 工具的接受和拒绝计数。
`web_search_count`	网络搜索工具调用的总数。这适用于 claude.ai 和您组织内的 Claude 代码使用。

Office Agent 指标（每个用户）

office_metrics 对象包含两个键：excel 和 powerpoint。

每个键包含相同的六个字段：

字段	描述
`office_metrics.[product].distinct_session_count*`	不同 Office Agent 会话的数量。
`office_metrics.[product].message_count`	发送的消息数（每个完成的代理轮次一条）。
`office_metrics.[product].skills_used_count`	技能调用总数。单个技能使用五次计为五次。
`office_metrics.[product].distinct_skills_used_count`	使用的不同技能的数量。
`office_metrics.[product].connectors_used_count`	连接器调用总数。单个连接器使用三次计为三次。
`office_metrics.[product].distinct_connectors_used_count`	使用的不同连接器的数量。

*注意：其中 [product] 是 excel 或 powerpoint 之一。

示例请求

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/users?date=2025-01-01&limit=3"
   --header "x-api-key: $YOUR_API_KEY"

2. 活动摘要

GET /v1/organizations/analytics/summaries

返回您组织在给定日期范围内的参与度和座位利用率的高级摘要，按天统计。响应是日期范围内具有聚合计数的天数列表。请注意，ending_date 和 starting_date 之间的最大差异必须为 31 天，数据可用性有三天延迟。这对于跟踪日活跃用户、周和月趋势以及座位分配一览很有用。

我们定义"活跃" 如果以下任何一项为真：

用户在 Claude（聊天）上发送了至少一条聊天消息。
用户有至少一个与 C4E 组织关联的 Claude Code（本地或远程）会话，具有工具使用/git 活动

查询参数

字段	类型	必需	描述
`starting_date`	字符串	是	要检索数据的开始日期，格式为 YYYY-MM-DD。数据可用性有三天延迟，因此您可以访问的最新数据来自三天前。
`ending_date`	字符串	否	要检索数据的可选结束日期，格式为 YYYY-MM-DD。这是排他的。

响应字段

字段	描述
`starting_date`	聚合指标的第一天，解释为 UTC 日期。数据可用性有三天延迟，因此您可以访问的最新数据来自三天前。
`ending_date`	聚合指标的最后一天（排他），解释为 UTC 日期
`daily_active_user_count`	在指定日期活跃的用户数（基于令牌消耗）。
`weekly_active_user_count`	在以指定日期结束的7天滚动窗口内活跃的用户数。
`monthly_active_user_count`	在以指定日期结束的30天滚动窗口内活跃的用户数。
`assigned_seat_count`	您的组织中当前分配的座位总数。
`pending_invite_count`	尚未被接受的待处理邀请数。

注意：周和月计数的滚动窗口从指定日期向后查看（包括该日期）。如果窗口内某些天的数据不完整（例如，如果日期距今不足30天），月计数可能会低估活动。

示例请求

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/summaries?starting_date=2025-01-01"
   --header "x-api-key: $YOUR_API_KEY"

3. 聊天项目使用情况

GET /v1/organizations/analytics/apps/chat/projects

返回给定日期按聊天项目分类的使用数据。项目特定于Claude（聊天），因此此端点专注于该界面。每个项目显示项目名称、与其交互的唯一用户数以及该项目中进行的对话总数。

查询参数

字段	类型	必需	描述
`date`	字符串	是	要检索指标的日期，格式为YYYY-MM-DD。数据可用性有三天延迟，因此您可以访问的最新数据来自三天前。
`limit`	整数	否	每页记录数（默认值：100，最大值：1000）。
`page`	字符串	否	来自上一个响应的`next_page`字段的游标令牌，用于检索下一页。

响应字段（每个项目）

字段	描述
`project_name`	项目的名称。
`project_id`	标记的项目ID，即
`distinct_user_count`	在给定日期使用此项目的唯一用户数。
`distinct_conversation_count`	给定日期此项目中的对话数。
`message_count`	给定日期内在此项目中发送的消息总数。
`created_at`	项目创建时间戳。
`created_by`	创建项目的用户的`{id, email_address}`。

示例请求

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects?date=2025-01-01&limit=50"
   --header "x-api-key: $YOUR_API_KEY"

4. 技能使用情况

GET /v1/organizations/analytics/skills

返回您组织内Claude（聊天）和Claude Code在给定日期的技能使用数据。每项代表一个技能，显示有多少个独立用户使用了它。

查询参数

字段	类型	必需	描述
`date`	字符串	是	要检索指标的日期，格式为YYYY-MM-DD。数据可用性有三天延迟，因此您可以访问的最新数据来自三天前。
`limit`	整数	否	每页记录数（默认值：100，最大值：1000）。
`page`	字符串	否	来自上一个响应的`next_page`字段的游标令牌，用于检索下一页。

响应字段（每个技能）

字段	描述
`skill_name`	技能的名称。
`distinct_user_count`	在给定日期使用此技能的独立用户数。
`chat_metrics.distinct_conversation_skill_used_count`	在聊天中至少使用过一次该技能的不同对话数。
`claude_code_metrics.distinct_session_skill_used_count`	在Claude Code中至少使用过一次该技能的不同远程会话数。

Office Agent指标（每个技能）

每个技能记录还包括一个office_metrics对象，报告有多少个Office Agent会话使用了该技能，按产品分类。此块始终存在——没有Office Agent使用的组织显示全零值。

字段	描述
`office_metrics.excel.distinct_session_skill_used_count`	在Excel中使用此技能的不同Office Agent会话数。
`office_metrics.powerpoint.distinct_session_skill_used_count`	在PowerPoint中使用此技能的不同Office Agent会话数。

示例请求

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/skills?date=2025-01-01"
   --header "x-api-key: $YOUR_API_KEY"

5. 连接器使用情况

GET /v1/organizations/analytics/connectors

返回您组织内Claude（聊天）和Claude Code在给定日期的MCP/连接器使用数据。每项代表一个连接器，显示有多少个独立用户使用了它。连接器名称从各种来源规范化——例如，"Atlassian MCP server"、"mcp-atlassian"和"atlassian_MCP"都会显示为"atlassian"。

查询参数

字段	类型	必需	描述
`date`	字符串	是	检索指标的日期，格式为 YYYY-MM-DD。数据可用性有三天延迟，因此您可以访问的最新数据来自三天前。
`limit`	整数	否	每页记录数（默认值：100，最大值：1000）。
`page`	字符串	否	来自上一个响应的 `next_page` 字段的游标令牌，用于检索下一页。

响应字段（按连接器）

字段	描述
`connector_name`	连接器的规范化名称。
`distinct_user_count`	在给定日期使用此连接器的唯一用户数。
`chat_metrics.distinct_conversation_connector_used_count`	在聊天中至少使用过一次连接器的不同对话数。
`claude_code_metrics.distinct_session_connector_used_count`	在 Claude Code 中至少使用过一次该技能的不同远程会话数。

Office Agent 指标（按连接器）

每个连接器记录还包括一个 office_metrics 对象，该对象报告有多少 Office Agent 会话使用了该连接器，按产品分类。此块始终存在——没有 Office Agent 使用的组织会看到全零值。

字段	描述
`office_metrics.excel.distinct_session_connector_used_count`	在 Excel 中使用此连接器的不同 Office Agent 会话数。
`office_metrics.powerpoint.distinct_session_connector_used_count`	在 PowerPoint 中使用此连接器的不同 Office Agent 会话数。

示例请求

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/connectors?date=2025-01-01"
   --header "x-api-key: $YOUR_API_KEY"

Claude 入门指南

在 Canvas by Instructure 中设置 Claude LTI

查看 Team 和 Enterprise 计划的使用分析

使用 Analytics API 访问参与度和采用数据

通过第三方平台在 Excel 和 PowerPoint 中使用 Claude