概述
Claude 企業分析 API 為您的組織提供對企業組織內 Claude 各個平台的參與度、採用率、使用情況和成本數據的程式化存取。無論您是在為使用者活動建立內部儀表板、追蹤專案的採用情況、對帳支出與月度帳單,還是設定支出限制,此 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。
重要:不要在成本和使用端點上的序列中途變更查詢參數。遊標繫結到發出它們的篩選條件和日期範圍。如果您變更 products[]、order_by、group_by[]、日期範圍或任何篩選條件並傳遞舊遊標,您將收到 400 錯誤。
錯誤回應
所有端點都會傳回標準 HTTP 錯誤代碼:
代碼 | 含義 |
400 | 查詢參數無效。常見原因包括無效的日期、1/1/26 之前的日期(首次可用)、今天或未來的日期,或(在成本和使用端點上)與目前查詢參數不符的頁面遊標。 |
401 | 遺失或無效的 API 金鑰(成本和使用端點)。 |
404 | API 金鑰遺失、無效或沒有 |
410 | 頁面遊標不再有效。從第一頁重新開始分頁。 |
429 | 超過速率限制。請求過多。 |
500 | 內部錯誤(成本和使用端點)。 |
504 | 請求逾時。 |
速率限制
我們確實有適用於此 API 中所有端點的預設速率限制。如果這對您的使用案例不夠,我們很樂意瞭解原因。如有必要,我們可以調整您組織的速率限制 — 請聯絡您的 CSM。
參與度和採用端點
1. 列出使用者活動
GET /v1/organizations/analytics/users
傳回單一日期的每個使用者參與度指標。回應中的每個項目代表一個使用者,並包含他們在 Claude(聊天)和 Claude Code 中的活動計數。
查詢參數
欄位 | 類型 | 必需 | 描述 |
| 字串 | 是 | 要擷取指標的日期,格式為 YYYY-MM-DD。 |
| 整數 | 否 | 每頁記錄數(預設值:20,最大值:1000)。 |
| 字串 | 否 | 來自前一個回應的 |
回應欄位(每位使用者)
欄位 | 描述 |
| 使用者的唯一識別碼。 |
| 使用者的電子郵件地址。 |
| 不同對話的數量,特別是在 Claude.ai 內。 |
| 已傳送的訊息總數,特別是在 Claude.ai 內。 |
| 建立的不同專案數量,特別是在 Claude.ai 內。 |
| 使用的不同專案數量,特別是在 Claude.ai 內。 |
| 上傳的不同檔案數量,特別是在 Claude.ai 內。 |
| 建立的不同成品數量,特別是在 Claude.ai 內。 |
| 檢視的不同共享成品數量,特別是在 Claude.ai 內。 |
| 思考(延伸)訊息的數量,特別是在 Claude.ai 內。 |
| 使用的不同技能數量,特別是在 Claude.ai 內。 |
| 叫用的連接器總數,特別是在 Claude.ai 內。 |
| 檢視的共享對話數量,特別是在 Claude.ai 內。 |
| 透過 Claude Code 進行的 git 提交數量。 |
| 透過 Claude Code 建立的提取請求數量。 |
| 新增的程式碼總行數。 |
| 移除的程式碼總行數。 |
| 不同 Claude Code 工作階段的數量。 |
| 編輯工具的接受和拒絕計數。 |
| 多重編輯工具的接受和拒絕計數。 |
| 寫入工具的接受和拒絕計數。 |
| 筆記本編輯工具的接受和拒絕計數。 |
| 網路搜尋工具叫用的總次數。這適用於 claude.ai 和您組織內的 Claude Code 使用。 |
Office Agent 指標(每位使用者)
每個使用者記錄也包含一個 office_metrics 物件,其中包含 Excel 和 PowerPoint 的按產品細分。此區塊在每筆記錄上始終存在—沒有 Office Agent 使用的組織會看到全零值而非 null。
office_metrics 物件包含兩個鍵:excel 和 powerpoint。
每個鍵包含相同的六個欄位:
欄位 | 說明 |
| 不同 Office Agent 工作階段的數量。 |
| 已傳送的訊息數(每個完成的代理程式回合一個)。 |
| 技能叫用總次數。使用一次技能五次計為五次。 |
| 使用的不同技能數量。 |
| 連接器叫用總次數。使用一次連接器三次計為三次。 |
| 使用的不同連接器數量。 |
*注意: 其中 [product] 是 excel 或 powerpoint 之一。
Claude Cowork 指標(每位使用者)
每個使用者記錄也包含一個 cowork_metrics 物件,其中包含每位使用者的 Cowork 參與度。此區塊在每筆記錄上始終存在—沒有 Cowork 使用的組織會看到全零值而非 null。
欄位 | 說明 |
| 不同 Cowork 工作階段的數量。 |
| 在 Cowork 中傳送的使用者訊息總數。 |
| 成功的工具呼叫(Bash、Read、Edit 等)。 |
| Dispatch(背景代理程式)工作階段中完成的代理程式回合。 |
| 技能叫用總次數。使用一次技能五次計為五次。 |
| 使用的不同技能數量。 |
| 連接器調用總數。單個連接器使用三次計為三次。 |
| 使用的不同連接器數量。 |
範例請求
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 (chat) 上至少發送了一條聊天訊息。
用戶至少有一個與 C4E 組織相關聯的 Claude Code (本地或遠端) 工作階段,具有工具使用/git 活動。
用戶至少有一個具有工具使用或訊息活動的 Claude Cowork 工作階段。
查詢參數
欄位 | 類型 | 必需 | 描述 |
| 字符串 | 是 | 要檢索數據的開始日期,格式為 YYYY-MM-DD。數據可用性有三天延遲,因此您可以訪問的最新數據來自三天前。 |
| 字符串 | 否 | 要檢索數據的可選結束日期,格式為 YYYY-MM-DD。這是排他性的。 |
回應欄位
欄位 | 描述 |
| 聚合指標的第一天,解釋為 UTC 日期。數據可用性有三天延遲,因此您可以訪問的最新數據來自三天前。 |
| 聚合指標的最後一天 (排他性),解釋為 UTC 日期 |
| 在指定日期活躍的用戶數 (基於令牌消耗)。 |
| 在指定日期結束的 7 天滾動窗口內活躍的用戶數。 |
| 在指定日期結束的 30 天滾動窗口內活躍的用戶數。 |
| 您的組織中當前分配的座位總數。 |
| 尚未被接受的待處理邀請數。 |
| 該天有 ≥1 個 Cowork 工作階段的用戶數 |
| 在 7 天滾動期間內有 ≥1 個 Cowork 工作階段的用戶數。 |
| 在 30 天滾動期間內有 ≥1 個 Cowork 工作階段的用戶數。 |
注意:每週和每月計數的滾動窗口從指定日期向後查看 (包括該日期)。如果窗口內某些天的數據不完整 (例如,如果日期距今不到 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(聊天),因此此端點專注於該介面。每個項目顯示專案名稱、與其互動的唯一使用者數量,以及該專案中進行的對話總數。
查詢參數
欄位 | 類型 | 必需 | 描述 |
| 字串 | 是 | 要檢索指標的日期,格式為 YYYY-MM-DD。數據可用性有三天延遲,因此您可以存取的最新數據是三天前的。 |
| 整數 | 否 | 每頁記錄數(預設值:100,最大值:1000)。 |
| 字串 | 否 | 來自前一個回應的 |
回應欄位(每個專案)
欄位 | 描述 |
| 專案的名稱。 |
| 標記的專案 ID,即 "claude_proj_{ID}" |
| 在指定日期使用此專案的唯一使用者數量。 |
| 指定日期此專案中的對話數量。 |
| 指定日期內在此專案中發送的訊息總數。 |
| 專案建立時間戳記。 |
| 建立專案的使用者的 |
範例請求
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 的技能使用數據。每個項目代表一項技能,並顯示有多少唯一使用者使用了它。
查詢參數
欄位 | 類型 | 必需 | 描述 |
| 字串 | 是 | 要檢索指標的日期,格式為 YYYY-MM-DD。資料可用性有三天的延遲,因此您可以存取的最新資料是來自三天前的資料。 |
| 整數 | 否 | 每頁的記錄數(預設值:100,最大值:1000)。 |
| 字串 | 否 | 來自前一個回應的 |
回應欄位(每項技能)
欄位 | 說明 |
| 技能的名稱。 |
| 在指定日期使用此技能的唯一使用者數量。 |
| 在聊天中至少使用過一次該技能的不同對話數量。 |
| 在 Claude Code 中至少使用過一次該技能的不同遠端工作階段數量。 |
Office Agent 指標(每項技能)
每項技能記錄也包含一個 office_metrics 物件,該物件報告有多少 Office Agent 工作階段使用了該技能,並按產品分類。此區塊始終存在——沒有 Office Agent 使用的組織會看到所有零值。
欄位 | 說明 |
| 在 Excel 中使用此技能的不同 Office Agent 工作階段數量。 |
| 在 PowerPoint 中使用此技能的不同 Office Agent 工作階段數量。 |
Claude Cowork 指標(每項技能)
每項技能記錄也包含一個 cowork_metrics 物件,該物件報告有多少 Cowork 工作階段使用了該技能。此區塊始終存在——沒有 Cowork 使用的組織會看到所有零值。
| 至少使用過一次此技能的不同 Cowork 工作階段數量。 |
範例請求
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」。
查詢參數
欄位 | 類型 | 必需 | 說明 |
| 字串 | 是 | 要檢索指標的日期,格式為 YYYY-MM-DD。資料可用性有三天的延遲,因此您可以存取的最新資料是來自三天前的資料。 |
| 整數 | 否 | 每頁的記錄數(預設值:100,最大值:1000)。 |
| 字符串 | 否 | 來自前一個回應的 |
回應欄位(每個連接器)
欄位 | 說明 |
| 連接器的標準化名稱。 |
| 在指定日期使用此連接器的唯一使用者數量。 |
| 在聊天中至少使用過一次連接器的不同對話數量。 |
| 在 Claude Code 中至少使用過一次連接器的不同遠端工作階段數量。 |
Office Agent 指標(每個連接器)
每個連接器記錄也包含一個 office_metrics 物件,報告有多少 Office Agent 工作階段使用了連接器,按產品細分。此區塊始終存在—沒有 Office Agent 使用的組織會看到全零值。
欄位 | 說明 |
| 在 Excel 中使用此連接器的不同 Office Agent 工作階段數量。 |
| 在 PowerPoint 中使用此連接器的不同 Office Agent 工作階段數量。 |
Claude Cowork 指標(每個連接器)
每個連接器記錄也包含一個 cowork_metrics 物件,報告有多少 Cowork 工作階段使用了連接器。此區塊始終存在—沒有 Cowork 使用的組織會看到全零值。
欄位 | 說明 |
| 至少使用過一次此連接器的不同 Cowork 工作階段數量。 |
範例請求
curl -X GET "https://api.anthropic.com/v1/organizations/analytics/connectors?date=2025-01-01"
--header "x-api-key: $YOUR_API_KEY"
成本和使用端點
注意:成本和使用端點適用於基於使用量的企業方案。對於基於座位的企業方案,這些端點將僅反映使用額度。
成本和使用端點(目前以測試版提供)為您的組織提供對 Claude(聊天)、Claude Code、Cowork、Office Agent 和 Chrome 中 Claude 的令牌和美元成本資料的程式設計存取。
有四個端點分為兩種形式:
形式 | 端點 | 傳回 |
每個使用者(每個使用者一列,已排序) | user_usage_report、user_cost_report | 按日期範圍內的令牌或支出排名的使用者。 |
分組(每個時間分組一列,可選分組) | usage_report、cost_report | 使用量或成本隨時間變化,按產品、模型或其他維度細分。 |
使用每個使用者端點來回答「我的最大支出者是誰?」使用分組端點來回答「使用量如何逐日趨勢,按產品細分?」
資料新鮮度和最終性
資料通常在基礎使用後四小時內可用,但可能需要長達 24 小時。每個回應都包含一個 data_refreshed_at 時間戳,指示回應所來自的匯出;該水位線之後發生的使用尚未反映。
給定日期的值可能會在 30 天內修訂,因為遲到的事件到達並執行協調。對於發票級別的總計,查詢至少 30 天前的日期。
當省略 ending_at(預設為「現在」)時,回應將包含 data_refreshed_at 之後的資料尾部,該尾部不完整。為了在重複呼叫中獲得穩定的結果,請將 ending_at 設定為先前傳回的 data_refreshed_at 時或之前的值。
日期範圍限制
starting_at 最多可以是過去的 365 天,單個查詢最多可以跨越 31 天(ending_at - starting_at)。要涵蓋更長的時間段,請使用相鄰的時間窗口發出多個查詢。2026-01-01 之前沒有可用的資料。
分頁
所有四個成本和使用端點都使用不透明遊標進行分頁。第一個請求返回最多 limit 行加上 next_page 遊標;在下一個請求中將該遊標原封不動地作為 page 參數傳遞,並重複此操作直到 has_more 為 false。
將 next_page 視為不透明:在下一個請求中原封不動地傳遞它,並在每一頁上發送相同的查詢參數。如果請求返回 400 或 410 並帶有關於頁面遊標的消息,請丟棄它並從第一頁重新開始。
不要在序列中途更改查詢參數。遊標綁定到發出它們的篩選條件和日期範圍。如果您更改 products[]、order_by、group_by[]、日期範圍或任何篩選條件並傳遞舊遊標,您將收到 400 錯誤。
序列化列表參數
列表參數使用括號表示法:對每個值重複參數名稱加上 []。
products[]=chat&products[]=claude_code
Actor 對象
每個按用戶的結果行識別生成使用情況的用戶。
{
"type": "user_actor",
"user_id": "user_01AbCdEfGh",
"name": "Jane Smith",
"email": "[email protected]"
}
欄位 | 類型 | 描述 |
type | string | 始終為 "user_actor"。 |
user_id | string | 用戶的 ID。user_ids[] 接受的相同值。 |
name | string or null | 用戶的名稱。如果用戶被刪除,則為「已刪除用戶」。 |
string or null | 用戶的電子郵件地址。用戶刪除時為 Null。 | |
deleted | boolean | 如果帳戶已被刪除,則為 True。 |
6. 按用戶的令牌使用情況
GET /v1/organizations/analytics/user_usage_report
返回按選定令牌指標排序的日期範圍內的按用戶令牌使用情況。
查詢參數
欄位 | 類型 | 必需 | 預設 | 描述 |
starting_at | RFC 3339 datetime | 是 | — | 範圍的開始,包括在內。向下舍入到 UTC 小時的開始。必須在過去 365 天內。 |
ending_at | RFC 3339 datetime | 否 | now | 範圍的結束,不包括在內。範圍最多可跨越 31 天。 |
products[] | chat、claude_code、cowork、office_agent、claude_in_chrome、claude_design 中的一個或多個 | 否 | 所有基於座位的產品 | 僅限基於座位的產品表面。重複參數以獲取多個值。 |
models[] | 字串,最多 100 個項目 | 否 | 全部 | 篩選特定模型名稱(例如 claude-opus-4-6、claude-sonnet-4-6、claude-haiku-4-5-20251001)。 |
user_ids[] | 字串,最多 100 個項目 | 否 | 全部 | 篩選特定使用者。適用於查詢已知的使用者集合,無需分頁整個組織。 |
context_windows[] | 0-200k、200k-1M 中的一個或多個 | 否 | 全部 | 篩選特定內容視窗定價層級。使用 group_by[]=context_window 以按層級分解值。 |
inference_geos[] | global、us、not_available 中的一個或多個 | 否 | 全部 | 篩選特定推論區域。not_available 符合區域未設定的列。使用 group_by[]=inference_geo 以按區域分解值。 |
speeds[] | fast、standard 中的一個或多個 | 否 | 全部 | 篩選快速或標準推論模式。使用 group_by[]=speed 以按模式分解值。 |
group_by[] | product、model、context_window、inference_geo、speed 中的一個或多個 | 否 | 無 | 按指定維度分解每個使用者的列。若有維度存在,一個使用者可能跨越多列。 |
order_by | total_tokens、output_tokens、uncached_input_tokens | 否 | total_tokens | 排序依據的指標。 |
exclude_deleted_users | 布林值 | 否 | false | 若為 true,則省略已刪除使用者的列。 |
order | desc、asc | 否 | desc | 排序方向。 |
limit | 整數 1–1000 | 否 | 20 | 每頁列數。 |
頁面 | 不透明遊標字串 | 否 | — | 來自先前回應的 next_page 值。 |
回應欄位
欄位 | 說明 |
organization_id | API 金鑰所屬組織的 ID。 |
data | 按 order_by 排序方向排序的項目陣列。 |
data[].actor | 產生使用情況的使用者的 Actor 物件。 |
data[].product | 當 group_by[] 包含 product 時,產品表面。否則為 null。 |
data[].model | 當 group_by[] 包含 model 時,模型名稱。否則為 null。 |
data[].context_window | 當 group_by[] 包含 context_window 時,內容層級 (0-200k 或 200k-1M)。否則為 null。 |
data[].inference_geo | 當 group_by[] 包含 inference_geo 時,推論區域。否則為 null。 |
data[].speed | 當 group_by[] 包含 speed 時:fast 或 standard。否則為 null。 |
data[].uncached_input_tokens | 未從提示快取提供的輸入權杖。 |
data[].cache_creation.ephemeral_5m_input_tokens | 寫入 5 分鐘提示快取的權杖。 |
data[].cache_creation.ephemeral_1h_input_tokens | 寫入 1 小時提示快取的權杖。 |
data[].cache_read_input_tokens | 從提示快取提供的輸入權杖。 |
data[].output_tokens | 產生的輸出權杖。 |
data[].total_tokens | 上述所有權杖元件的總和。預設 order_by=total_tokens 會根據此值排序。 |
data[].server_tool_use.web_search_requests | 網路搜尋工具呼叫次數。 |
data[].requests | API 請求數 |
has_more | 是否存在另一個頁面。 |
next_page | 下一頁的不透明遊標;當 has_more 為 false 時為 null。 |
data_refreshed_at | 此回應所提供的資料匯出的時間戳記。 |
範例請求
curl "https://api.anthropic.com/v1/organizations/analytics/user_usage_report?starting_at=2026-03-01T00:00:00Z&products[]=claude_code&order_by=output_tokens&limit=20" \
--header "x-api-key: $YOUR_API_KEY"
7. 每位使用者成本
GET /v1/organizations/analytics/user_cost_report
在日期範圍內傳回每位使用者的 USD 成本,按折扣或標價金額排序。
查詢參數
與 user_usage_report 相同,但有以下差異:
欄位 | 類型 | 必需 | 預設值 | 說明 |
order_by | amount、list_amount | 否 | amount | 排序依據的指標。 |
group_by[] | product、model、context_window、inference_geo、speed、cost_type、token_type 中的一個或多個 | 否 | 無 | 按指定維度分解每個使用者的列。cost_type 會為每個成本元件(代幣、網路搜尋、程式碼執行)傳回一列;token_type 會為每個代幣類型傳回一列。 |
所有其他參數(starting_at、ending_at、products[]、models[]、user_ids[]、order、limit、page)相同。
回應欄位
欄位 | 說明 |
organization_id | API 金鑰所屬組織的 ID。 |
data | 按 order_by 排序的項目陣列,按順序方向排列。 |
data[].actor | 產生成本的使用者的 Actor 物件。 |
data[].product、data[].model、data[].context_window、data[].inference_geo、data[].speed | 設定對應 group_by[] 值時,為維度值。否則為 null。 |
data[].currency | 始終為 "USD"。 |
data[].amount | 以分數美分計的金額 — 協商折扣後的原始消費成本。例如,"41280.000000" 表示 $412.80。該值在 products[] 篩選器中的所有產品中求和。 |
data[].list_amount | 清單價格金額(折扣前),以分數美分計,格式相同。 |
data[].cost_type | 當 group_by[] 包含 cost_type 時:tokens、web_search、code_execution 之一。未設定時為 null。 |
data[].token_type | 當 group_by[] 包含 token_type 時:uncached_input_tokens、output_tokens、cache_read_input_tokens、cache_creation.ephemeral_5m_input_tokens、cache_creation.ephemeral_1h_input_tokens 之一。僅在 cost_type 為 tokens 的列上非 null。 |
data[].requests | API 請求數 |
has_more | 是否存在另一頁。 |
next_page | 下一頁的不透明遊標。 |
data_refreshed_at | 此回應所提供的資料匯出的時間戳記。 |
解析金額
amount 和 list_amount 是以美分計的十進位字串。"41280.000000" 表示 41,280 美分(美元 $412.80)。若要轉換為美元,請解析為十進位並除以 100。避免對可能超過數百萬美元的值進行二進位浮點解析。
範例請求
curl "https://api.anthropic.com/v1/organizations/analytics/user_cost_report?starting_at=2026-03-01T00:00:00Z&order_by=amount&limit=20" \
--header "x-api-key: $YOUR_API_KEY"
8. 代幣使用量隨時間變化
GET /v1/organizations/analytics/usage_report
返回代幣使用量隨時間變化,按分鐘、小時或天分組,可選擇按產品、模型、上下文視窗、推理區域或速度進一步細分。
查詢參數
欄位 | 類型 | 必需 | 預設值 | 描述 |
starting_at | RFC 3339 datetime | 是 | — | 範圍的開始,包含該邊界。必須在過去365天內。向下取整到最近的bucket_width邊界(UTC)。 |
ending_at | RFC 3339 datetime | 否 | 現在 | 範圍的結束,不包含該邊界。範圍最多可跨越31天。向下取整到最近的bucket_width邊界(UTC)。 |
bucket_width | 1m, 1h, 1d | 否 | 1d | 時間分組粒度:分鐘、小時或天。 |
group_by[] | product、model、context_window、inference_geo、speed 中的一個或多個 | 否 | 無 | 每個分組內要細分的維度。省略此參數則每個分組只返回一個聚合值。 |
products[] | chat、claude_code、cowork、office_agent、claude_in_chrome、claude_design 中的一個或多個 | 否 | 全部 | 篩選特定產品表面。 |
models[] | 字串,最多100個條目 | 否 | 全部 | 篩選特定模型名稱。 |
context_windows[] | 0-200k、200k-1M 中的一個或多個 | 否 | 全部 | 篩選特定上下文視窗定價層級。使用 group_by[]=context_window 可按層級細分值。 |
inference_geos[] | global、us、not_available 中的一個或多個 | 否 | 全部 | 篩選特定推理區域。not_available 符合區域未設定的列。使用 group_by[]=inference_geo 可按區域細分值。 |
speeds[] | 快速或標準中的一個或多個 | 否 | 全部 | 篩選至快速或標準推理模式。 |
user_ids[] | 字串,最多 100 個條目 | 否 | 全部 | 篩選至特定使用者。 |
limit | 整數 | 否 | 變動 | 每頁的時間桶數。預設值和最大值因 bucket_width 而異:1d → 7(最多 31);1h → 24(最多 168);1m → 60(最多 256)。 |
page | 不透明遊標字串 | 否 | — | 來自先前回應的 next_page 值。 |
回應欄位
欄位 | 說明 |
organization_id | API 金鑰所屬組織的 ID。 |
data | 項目陣列,每個時間桶一個。 |
data[].starting_at | 時間桶開始。 |
data[].ending_at | 時間桶結束。 |
data[].results | 項目陣列,時間桶內每個群組一個。當省略 group_by[] 時,所有維度欄位均為 null 的單一項目。 |
data[].results[].product, .model, .context_window, .inference_geo, .speed | 設定對應的 group_by[] 值時,為維度值。否則為 null。 |
data[].results[].uncached_input_tokens | 未從提示快取提供的輸入權杖。 |
data[].results[].cache_creation.ephemeral_5m_input_tokens | 寫入 5 分鐘提示快取的權杖。 |
data[].results[].cache_creation.ephemeral_1h_input_tokens | 寫入 1 小時提示快取的權杖。 |
data[].results[].cache_read_input_tokens | 從提示快取提供的輸入權杖。 |
data[].results[].output_tokens | 產生的輸出權杖。 |
data[].results[].server_tool_use.web_search_requests | 網路搜尋工具呼叫次數。 |
has_more | 是否存在更多時間桶。 |
next_page | 下一頁的不透明遊標。 |
data_refreshed_at | 此回應所提供的資料匯出時間戳記。 |
範例請求
--header "x-api-key: $YOUR_API_KEY"
9. 一段時間內的成本
GET /v1/organizations/analytics/cost_report
返回一段時間內的美元成本,以與 usage_report 相同的方式分組和分類。
查詢參數
與 usage_report 相同(bucket_width、group_by[]、filters、limit、page)。group_by[] 值在此端點上另外接受 cost_type 和 token_type。
回應欄位
欄位 | 說明 |
organization_id | API 金鑰所屬組織的 ID。 |
data | 項目陣列,每個時間區間一個。 |
data[].starting_at | 區間開始。 |
data[].ending_at | 區間結束。 |
data[].results | 項目陣列,區間內每個群組一個。 |
data[].results[].product、.model、.context_window、.inference_geo、.speed | 設定對應的 group_by[] 值時,為維度值。否則為 null。 |
data[].results[].cost_type | 當 group_by[] 包含 cost_type 時:tokens、web_search 或 code_execution。未設定時為 null。 |
data[].results[].token_type | 當 group_by[] 包含 token_type 時:端點 7 下列出的其中一個權杖類型。僅限成本端點 — usage_report 上拒絕 token_type。 |
data[].results[].currency | 始終為 "USD"。 |
data[].results[].amount | 以小數分為單位的金額 — 協商折扣後的原始消費成本。 |
data[].results[].list_amount | 清單價格金額(折扣前),以小數分為單位。 |
has_more | 是否存在更多區間。 |
next_page | 下一頁的不透明游標。 |
data_refreshed_at | 此回應所提供的資料匯出時間戳記。 |
範例請求
curl "https://api.anthropic.com/v1/organizations/analytics/cost_report?starting_at=2026-03-01T00:00:00Z&bucket_width=1d&group_by[]=model" \
--header "x-api-key: $YOUR_API_KEY"
