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，即「claude_proj_{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"

商業夥伴協議 (BAA) - 商業客戶版本

Claude Code 使用分析

在 Claude Code 中管理 API 金鑰環境變數

查看 Team 和 Enterprise 方案的使用分析

透過第三方平台在 Excel 和 PowerPoint 中使用 Claude