跳转到主要内容

Claude 企业分析 API 参考指南

概述

Claude 企业分析 API 为您的组织提供对企业组织内 Claude 各个平台的参与度、采用率、使用情况和成本数据的编程访问权限。无论您是在构建用户活动的内部仪表板、跟踪项目的采用情况、对账月度账单支出,还是设置支出限额,此 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

重要:不要在成本和使用端点的序列中途更改查询参数。游标绑定到发出它们的过滤器和日期范围。如果您更改 products[]、order_by、group_by[]、日期范围或任何过滤器并传递旧游标,您将收到 400 错误。

错误响应

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

代码

含义

400

查询参数无效。常见原因包括无效的日期、1/1/26 之前的日期(首次可用)、今天或未来的日期,或(在成本和使用端点上)与当前查询参数不匹配的页面游标。

401

缺少或无效的 API 密钥(成本和使用端点)。

404

API 密钥缺失、无效或不具有read:analytics范围。

410

页面游标不再有效。从第一页重新开始分页。

429

超过速率限制。请求过多。

500

内部错误(成本和使用端点)。

504

请求超时。

速率限制

我们确实有适用于此 API 中所有端点的默认速率限制。如果这对您的用例不够,我们很想了解原因。如有必要,我们可以为您的组织调整速率限制 — 请与您的 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.distinct_shared_artifacts_viewed_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 内。

chat_metrics.shared_conversations_viewed_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使用。

Office Agent指标(每个用户)

每个用户记录还包括一个office_metrics对象,其中包含Excel和PowerPoint的按产品细分。此块始终存在于每条记录上——没有Office Agent使用的组织会看到全零值而不是null。

office_metrics对象包含两个键:excelpowerpoint

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

字段

描述

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]excelpowerpoint之一。

Claude Cowork指标(每个用户)

每个用户记录还包括一个cowork_metrics对象,其中包含每个用户的Cowork参与度。此块始终存在于每条记录上——没有Cowork使用的组织会看到全零值而不是null。

字段

描述

cowork_metrics.distinct_session_count

不同Cowork会话的数量。

cowork_metrics.message_count

在Cowork中发送的用户消息总数。

cowork_metrics.action_count

成功的工具调用(Bash、Read、Edit等)。

cowork_metrics.dispatch_turn_count

Dispatch(后台代理)会话中完成的代理轮次。

cowork_metrics.skills_used_count

技能调用总数。单个技能使用五次计为五次。

cowork_metrics.distinct_skills_used_count

使用的不同技能数量。

cowork_metrics.connectors_used_count

连接器调用总数。单个连接器使用三次计为三次。

cowork_metrics.distinct_connectors_used_count

使用的不同连接器数量。

示例请求

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活动。

  • 用户至少有一个Claude Cowork会话,具有工具使用或消息活动。

查询参数

字段

类型

必需

描述

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

尚未被接受的待处理邀请数。

cowork_daily_active_user_count

那天至少有≥1个Cowork会话的用户数。

cowork_weekly_active_user_count

在7天滚动期间内至少有≥1个Cowork会话的用户数。

cowork_monthly_active_user_count

在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(聊天),因此此端点专注于该界面。每项显示项目名称、与其交互的唯一用户数以及该项目中进行的对话总数。

查询参数

字段

类型

必需

描述

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 会话数。

Claude Cowork 指标(每个技能)

每个技能记录还包括一个 cowork_metrics 对象,该对象报告有多少 Cowork 会话使用了该技能。此块始终存在——没有 Cowork 使用的组织会看到全零值。

cowork_metrics.distinct_session_skill_used_count

至少使用过一次此技能的不同 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"。

查询参数

字段

类型

必需

描述

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 会话数。

Claude Cowork 指标(每个连接器)

每个连接器记录还包括一个 cowork_metrics 对象,该对象报告有多少 Cowork 会话使用了连接器。此块始终存在——没有 Cowork 使用的组织会看到全零值。

字段

描述

cowork_metrics.distinct_session_connector_used_count

至少使用过一次此连接器的不同 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 或 null

用户的名称。如果用户被删除,则为"已删除用户"。

email

string 或 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

现在

范围的结束,不包括在内。范围最多可跨越 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

为真时,省略已删除用户的行。

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 日期时间

范围的开始,包含该值。必须在过去365天内。向下舍入到最近的bucket_width边界(UTC)。

ending_at

RFC 3339 日期时间

现在

范围的结束,不包含该值。范围最多可跨越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"
这是否解答了您的问题?