跳至主要內容

Claude 企業分析 API 參考指南

今日已更新

概述

Claude Enterprise Analytics API 讓您的組織能以程式方式存取 Claude 和 Claude Code 在企業組織內的使用情況資料。無論您是在建立使用者活動的內部儀表板,還是追蹤專案的採用情況,此 API 都能提供您所需的彙總指標。

資料彙總

所有資料都會按組織、每日進行彙總。每個端點都會傳回您指定的單一日期的快照。第 N 天的資料(第 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

筆記本編輯工具的接受和拒絕計數。

web_search_count

網路搜尋工具叫用的總數。這適用於您組織內的 claude.ai 和 claude code 使用。

範例請求

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_datestarting_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

在給定日期此專案內傳送的訊息總數。

範例請求

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

是否回答了您的問題?