Ir para conteúdo principal

Guia de referência da API Claude Enterprise Analytics

Visão geral

A API Claude Enterprise Analytics oferece à sua organização acesso programático a dados de engajamento, adoção, uso e custo em todas as superfícies Claude dentro de sua organização Enterprise. Quer você esteja criando painéis internos para atividade de usuários, rastreando a adoção de projetos, reconciliando gastos com sua fatura mensal ou definindo limites de gastos, esta API fornece as métricas necessárias.

Agregação de dados

Todos os dados são agregados por organização, por dia. Cada endpoint retorna um snapshot para uma única data que você especifica. Os dados do dia (N-1) são processados às 10:00:00 UTC no dia N e estão disponíveis para consulta três dias após a agregação, para garantir a precisão dos dados.

Se os dados não estiverem disponíveis dentro do prazo acima, isso geralmente indica uma falha no pipeline de dados que nossa equipe precisará investigar internamente. Geralmente estamos cientes de tais problemas, mas entre em contato com seu CSM se quiser uma verificação ou suspeitar de algo diferente.

Os endpoints de custo e uso têm um modelo de atualização diferente. Consulte Endpoints de custo e uso abaixo para obter detalhes.

Habilitando acesso

Para criar novas chaves de API de análise, você deve ser um Proprietário Primário em sua organização Enterprise. Você pode fazer isso navegando para claude.ai/analytics/api-keys.

Alguns detalhes adicionais que podem ser úteis:

  • Você pode ativar/desativar o acesso à API pública a qualquer momento. Se você desativar o acesso alternando o switch, todas as solicitações serão negadas.

  • Você precisará de uma chave com o escopo read:analytics para acessar a API. Você pode criar várias chaves para sua organização, mas os limites de taxa se aplicam no nível da organização, não no nível da chave. Consulte a seção "Limitação de taxa" abaixo.

  • Como sempre, recomendamos fortemente o tratamento seguro de chaves de API: nunca compartilhe essas chaves publicamente - elas são secretas e devem ser compartilhadas com segurança.

URL base

Todas as solicitações são enviadas para:

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

Autenticação

Cada solicitação requer uma chave de API passada no cabeçalho x-api-key. Sua chave de API deve ter o escopo read:analytics. Você pode criar e gerenciar chaves de API nas configurações de administrador do claude.ai na seção Chaves de API.

Exemplo de cabeçalhos de solicitação:

x-api-key: $YOUR_API_KEY

Paginação

Vários endpoints retornam resultados paginados. A paginação usa uma abordagem baseada em cursor, onde a resposta inclui um token next_page que você passa novamente em sua próxima solicitação para recuperar a próxima página de resultados.

Dois parâmetros opcionais controlam a paginação:

limit (inteiro): Número de registros por página. O padrão é 20 para o endpoint /users e 100 para todos os outros endpoints. Para endpoints de custo e uso, os padrões variam por endpoint e largura de bucket — consulte Endpoints de custo e uso abaixo. O máximo é 1000.

page (string): O token de cursor opaco do campo next_page da resposta anterior. Omita isso em sua primeira solicitação.

Quando não há mais resultados, next_page será null na resposta.

Importante: Não altere parâmetros de consulta no meio da sequência em endpoints de custo e uso. Os cursores estão vinculados aos filtros e intervalo de datas que os emitiram. Se você alterar products[], order_by, group_by[], o intervalo de datas ou qualquer filtro e passar um cursor antigo, você receberá um erro 400.

Respostas de erro

Todos os endpoints retornam códigos de erro HTTP padrão:

Código

Significado

400

Um parâmetro de consulta é inválido. As causas comuns incluem uma data inválida, uma data anterior a 1º/1/26 (primeira disponibilidade), uma data que é hoje ou no futuro, ou (em endpoints de custo e uso) um cursor de página que não corresponde aos parâmetros de consulta atuais.

401

Chave de API ausente ou inválida (endpoints de custo e uso).

404

A chave de API está ausente, inválida ou não possui o escopo read:analytics.

410

O cursor de página não é mais válido. Reinicie a paginação a partir da primeira página.

429

Limite de taxa excedido. Muitas solicitações.

500

Erro interno (endpoints de custo e uso).

504

Solicitação expirou.

Limitação de taxa

Temos limites de taxa padrão em vigor que se aplicam a todos os endpoints nesta API. Se isso não for suficiente para seu caso de uso, gostaríamos de entender o porquê. Se necessário, podemos ajustar os limites de taxa para sua organização — entre em contato com seu CSM.


Endpoints de engajamento e adoção

1. Listar atividade do usuário

GET /v1/organizations/analytics/users

Retorna métricas de engajamento por usuário para um único dia. Cada item na resposta representa um usuário e inclui suas contagens de atividade em Claude (chat) e Claude Code.

Parâmetros de consulta

Campo

Tipo

Obrigatório

Descrição

date

string

Sim

A data para a qual recuperar métricas, no formato YYYY-MM-DD.

limit

integer

Não

Número de registros por página (padrão: 20, máximo: 1000).

page

string

Não

Token de cursor da resposta anterior's next_page campo para recuperar a próxima página.

Campos de resposta (por usuário)

Campo

Descrição

user.id

Identificador único do usuário.

user.email_address

O endereço de e-mail do usuário.

chat_metrics.distinct_conversation_count

Número de conversas distintas, especificamente no Claude.ai.

chat_metrics.message_count

Total de mensagens enviadas, especificamente no Claude.ai.

chat_metrics.distinct_projects_created_count

Número de projetos distintos criados, especificamente no Claude.ai.

chat_metrics.distinct_projects_used_count

Número de projetos distintos utilizados, especificamente no Claude.ai.

chat_metrics.distinct_files_uploaded_count

Número de arquivos distintos enviados, especificamente no Claude.ai.

chat_metrics.distinct_artifacts_created_count

Número de artefatos distintos criados, especificamente no Claude.ai.

chat_metrics.distinct_shared_artifacts_viewed_count

Número de artefatos compartilhados distintos visualizados, especificamente no Claude.ai.

chat_metrics.thinking_message_count

Número de mensagens de pensamento (estendidas), especificamente no Claude.ai.

chat_metrics.distinct_skills_used_count

Número de habilidades distintas utilizadas, especificamente no Claude.ai.

chat_metrics.connectors_used_count

Número total de conectores invocados, especificamente no Claude.ai.

chat_metrics.shared_conversations_viewed_count

Número de conversas compartilhadas visualizadas, especificamente no Claude.ai.

claude_code_metrics.core_metrics.commit_count

Número de commits do git feitos via Claude Code.

claude_code_metrics.core_metrics.pull_request_count

Número de pull requests criados via Claude Code.

claude_code_metrics.core_metrics.lines_of_code.added_count

Total de linhas de código adicionadas.

claude_code_metrics.core_metrics.lines_of_code.removed_count

Total de linhas de código removidas.

claude_code_metrics.core_metrics.distinct_session_count

Número de sessões distintas do Claude Code.

claude_code_metrics.tool_actions.edit_tool

Contagens de aceitos e rejeitados para a ferramenta Editar.

claude_code_metrics.tool_actions.multi_edit_tool

Contagens de aceitos e rejeitados para a ferramenta Multi-Editar.

claude_code_metrics.tool_actions.write_tool

Contagens de aceitos e rejeitados para a ferramenta Escrever.

claude_code_metrics.tool_actions.notebook_edit_tool

Contagens de aceitos e rejeitados para a ferramenta Editar Notebook.

web_search_count

Total de invocações da ferramenta de busca na web. Isso se aplica tanto a claude.ai quanto ao uso do Claude Code dentro de sua organização.

Métricas do Office Agent (por usuário)

Cada registro de usuário também inclui um objeto office_metrics com detalhamentos por produto para Excel e PowerPoint. Este bloco está sempre presente em cada registro—organizações sem uso do Office Agent veem valores zero em vez de nulo.

O objeto office_metrics contém duas chaves: excel e powerpoint.

Cada chave contém os mesmos seis campos:

Campo

Descrição

office_metrics.[product].distinct_session_count*

Número de sessões distintas do Office Agent.

office_metrics.[product].message_count

Número de mensagens enviadas (uma por turno do agente concluído).

office_metrics.[product].skills_used_count

Total de invocações de habilidades. Uma única habilidade usada cinco vezes conta como cinco.

office_metrics.[product].distinct_skills_used_count

Número de habilidades distintas usadas.

office_metrics.[product].connectors_used_count

Total de invocações de conectores. Um único conector usado três vezes conta como três.

office_metrics.[product].distinct_connectors_used_count

Número de conectores distintos usados.

*Nota: Onde [product] é um de excel ou powerpoint.

Métricas do Claude Cowork (por usuário)

Cada registro de usuário também inclui um objeto cowork_metrics com engajamento do Cowork por usuário. Este bloco está sempre presente em cada registro—organizações sem uso do Cowork veem valores zero em vez de nulo.

Campo

Descrição

cowork_metrics.distinct_session_count

Número de sessões distintas do Cowork.

cowork_metrics.message_count

Total de mensagens de usuário enviadas no Cowork.

cowork_metrics.action_count

Chamadas de ferramentas bem-sucedidas (Bash, Ler, Editar, etc.)

cowork_metrics.dispatch_turn_count

Turnos de agente concluídos em sessões do Dispatch (agente em segundo plano).

cowork_metrics.skills_used_count

Total de invocações de habilidades. Uma única habilidade usada cinco vezes conta como cinco.

cowork_metrics.distinct_skills_used_count

Número de habilidades distintas utilizadas.

cowork_metrics.connectors_used_count

Total de invocações de conectores. Um único conector usado três vezes conta como três.

cowork_metrics.distinct_connectors_used_count

Número de conectores distintos utilizados.

Exemplo de solicitação

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. Resumo de atividades

GET /v1/organizations/analytics/summaries

Retorna um resumo de alto nível do engajamento e utilização de assentos por dia para sua organização em um intervalo de datas especificado. A resposta é uma lista de dias com contagens agregadas dentro do intervalo de datas. Observe que a diferença máxima entre ending_date e starting_date deve ser 31 dias, e há um atraso de três dias na disponibilidade dos dados. Isso é útil para rastrear usuários ativos diários, tendências semanais e mensais e alocação de assentos em um relance.

Definimos "ativo" se qualquer uma das seguintes condições for verdadeira:

  • O usuário enviou pelo menos uma mensagem de chat no Claude (chat).

  • O usuário teve pelo menos uma sessão do Claude Code (local ou remota) associada à organização C4E, com uso de ferramentas/atividade git

  • O usuário teve pelo menos uma sessão do Claude Cowork com uso de ferramentas ou atividade de mensagens.

Parâmetros de consulta

Campo

Tipo

Obrigatório

Descrição

starting_date

string

Sim

A data inicial para recuperar dados, no formato YYYY-MM-DD. Há um atraso de três dias na disponibilidade dos dados, portanto, os dados mais recentes que você pode acessar são de três dias atrás.

ending_date

string

Não

A data final opcional para recuperar dados, no formato YYYY-MM-DD. Isso é exclusivo.

Campos de resposta

Campo

Descrição

starting_date

Primeiro dia para o qual as métricas são agregadas, interpretado como uma data UTC. Há um atraso de três dias na disponibilidade dos dados, portanto, os dados mais recentes que você pode acessar são de três dias atrás.

ending_date

Último dia (exclusivo) para o qual as métricas são agregadas, interpretado como uma data UTC

daily_active_user_count

Número de usuários ativos na data especificada (com base no consumo de tokens).

weekly_active_user_count

Número de usuários ativos dentro da janela móvel de 7 dias terminando na data especificada.

monthly_active_user_count

Número de usuários ativos dentro da janela móvel de 30 dias terminando na data especificada.

assigned_seat_count

Número total de assentos atualmente atribuídos em sua organização.

pending_invite_count

Número de convites pendentes que ainda não foram aceitos.

cowork_daily_active_user_count

Número de usuários com ≥1 sessão do Cowork naquele dia

cowork_weekly_active_user_count

Número de usuários com ≥1 sessão do Cowork em um período móvel de 7 dias.

cowork_monthly_active_user_count

Número de usuários com ≥1 sessão do Cowork em um período móvel de 30 dias.

Nota: As janelas móveis para contagens semanais e mensais olham para trás a partir da data especificada (inclusive). Se os dados estiverem incompletos para alguns dias dentro da janela (por exemplo, se a data for menos de 30 dias no passado), a contagem mensal pode subestimar a atividade.

Exemplo de solicitação

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

3. Uso do projeto de chat

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

Retorna dados de uso divididos por projeto de chat para uma data específica. Os projetos são específicos do Claude (chat), portanto este endpoint se concentra nessa superfície. Cada item mostra o nome do projeto, quantos usuários únicos interagiram com ele e o número total de conversas realizadas nesse projeto.

Parâmetros de consulta

Campo

Tipo

Obrigatório

Descrição

date

string

Sim

A data para a qual recuperar métricas, no formato YYYY-MM-DD. Há um atraso de três dias na disponibilidade dos dados, portanto os dados mais recentes que você pode acessar são de três dias atrás.

limit

integer

Não

Número de registros por página (padrão: 100, máximo: 1000).

page

string

Não

Token de cursor da resposta anterior next_page para recuperar a próxima página.

Campos de resposta (por projeto)

Campo

Descrição

project_name

O nome do projeto.

project_id

O ID do projeto marcado, ou seja, "claude_proj_{ID}"

distinct_user_count

Número de usuários únicos que usaram este projeto na data especificada.

distinct_conversation_count

Número de conversas neste projeto na data especificada.

message_count

Número total de mensagens enviadas dentro deste projeto na data especificada.

created_at

O timestamp de criação do projeto.

created_by

{id, email_address} do usuário que criou o projeto.

Exemplo de solicitação

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. Uso de habilidades

GET /v1/organizations/analytics/skills

Retorna dados de uso de habilidades em Claude (chat) e Claude Code dentro de sua organização para uma data específica. Cada item representa uma habilidade e mostra quantos usuários únicos a utilizaram.

Parâmetros de consulta

Campo

Tipo

Obrigatório

Descrição

date

string

Sim

A data para recuperar métricas, no formato YYYY-MM-DD. Há um atraso de três dias na disponibilidade dos dados, portanto, os dados mais recentes que você pode acessar são de três dias atrás.

limit

inteiro

Não

Número de registros por página (padrão: 100, máximo: 1000).

page

string

Não

Token de cursor da resposta anterior's next_page para recuperar a próxima página.

Campos de resposta (por habilidade)

Campo

Descrição

skill_name

O nome da habilidade.

distinct_user_count

Número de usuários únicos que usaram esta habilidade na data fornecida.

chat_metrics.distinct_conversation_skill_used_count

Número de conversas distintas em que a habilidade foi usada pelo menos uma vez, no chat.

claude_code_metrics.distinct_session_skill_used_count

Número de sessões remotas distintas em que a habilidade foi usada pelo menos uma vez, no Claude Code.

Métricas do Office Agent (por habilidade)

Cada registro de habilidade também inclui um objeto office_metrics que relata quantas sessões do Office Agent usaram a habilidade, divididas por produto. Este bloco está sempre presente — organizações sem uso do Office Agent veem todos os valores zero.

Campo

Descrição

office_metrics.excel.distinct_session_skill_used_count

Número de sessões distintas do Office Agent no Excel em que esta habilidade foi usada.

office_metrics.powerpoint.distinct_session_skill_used_count

Número de sessões distintas do Office Agent no PowerPoint em que esta habilidade foi usada.

Métricas do Claude Cowork (por habilidade)

Cada registro de habilidade também inclui um objeto cowork_metrics que relata quantas sessões do Cowork usaram a habilidade. Este bloco está sempre presente — organizações sem uso do Cowork veem todos os valores zero.

cowork_metrics.distinct_session_skill_used_count

Número de sessões distintas do Cowork em que esta habilidade foi usada pelo menos uma vez.

Exemplo de solicitação

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

5. Uso de conectores

GET /v1/organizations/analytics/connectors

Retorna dados de uso de MCP/conectores em Claude (chat) e Claude Code dentro de sua organização para uma data fornecida. Cada item representa um conector e mostra quantos usuários únicos o usaram. Os nomes dos conectores são normalizados de várias fontes — por exemplo, "Atlassian MCP server," "mcp-atlassian," e "atlassian_MCP" apareceriam todos como "atlassian."

Parâmetros de consulta

Campo

Tipo

Obrigatório

Descrição

date

string

Sim

A data para recuperar métricas, no formato YYYY-MM-DD. Há um atraso de três dias na disponibilidade dos dados, portanto, os dados mais recentes que você pode acessar são de três dias atrás.

limit

inteiro

Não

Número de registros por página (padrão: 100, máximo: 1000).

page

string

Não

Token de cursor do campo next_page de uma resposta anterior para recuperar a próxima página.

Campos de resposta (por conector)

Campo

Descrição

connector_name

O nome normalizado do conector.

distinct_user_count

Número de usuários únicos que usaram este conector na data especificada.

chat_metrics.distinct_conversation_connector_used_count

Número de conversas distintas em que o conector foi usado pelo menos uma vez, no chat.

claude_code_metrics.distinct_session_connector_used_count

Número de sessões remotas distintas em que o conector foi usado pelo menos uma vez, no Claude Code.

Métricas do Office Agent (por conector)

Cada registro de conector também inclui um objeto office_metrics que relata quantas sessões do Office Agent usaram o conector, dividido por produto. Este bloco está sempre presente—organizações sem uso do Office Agent veem todos os valores zerados.

Campo

Descrição

office_metrics.excel.distinct_session_connector_used_count

Número de sessões distintas do Office Agent no Excel em que este conector foi usado.

office_metrics.powerpoint.distinct_session_connector_used_count

Número de sessões distintas do Office Agent no PowerPoint em que este conector foi usado.

Métricas do Claude Cowork (por conector)

Cada registro de conector também inclui um objeto cowork_metrics que relata quantas sessões do Cowork usaram o conector. Este bloco está sempre presente—organizações sem uso do Cowork veem todos os valores zerados.

Campo

Descrição

cowork_metrics.distinct_session_connector_used_count

Número de sessões distintas do Cowork em que este conector foi usado pelo menos uma vez.

Exemplo de solicitação

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


Endpoints de custo e uso

Nota: Os endpoints de custo e uso se aplicam a planos Enterprise baseados em uso. Para planos Enterprise baseados em assentos, esses endpoints refletirão apenas créditos de uso.

Os endpoints de custo e uso (disponíveis agora em beta) fornecem à sua organização acesso programático aos dados de custo em tokens e USD para Claude (chat), Claude Code, Cowork, Office Agent e Claude no Chrome.

Existem quatro endpoints em duas formas:

Forma

Endpoints

Retorna

Por usuário (uma linha por usuário, classificada)

user_usage_report, user_cost_report

Usuários classificados por tokens ou gastos em um intervalo de datas.

Agrupado (uma linha por intervalo de tempo, opcionalmente agrupado)

usage_report, cost_report

Uso ou custo ao longo do tempo, dividido por produto, modelo ou outras dimensões.

Use os endpoints por usuário para responder "quem são meus maiores gastadores?" Use os endpoints agrupados para responder "como o uso está tendendo dia a dia, dividido por produto?"

Atualização e finalidade dos dados

Os dados geralmente estão disponíveis dentro de quatro horas do uso subjacente, mas podem levar até 24 horas. Cada resposta inclui um timestamp data_refreshed_at indicando a exportação da qual a resposta foi servida; o uso que ocorreu após essa marca d'água ainda não está refletido.

Os valores para uma data específica podem ser revisados por até 30 dias conforme eventos atrasados chegam e as execuções de reconciliação ocorrem. Para totais de qualidade de faturamento, consulte datas com pelo menos 30 dias no passado.

Quando ending_at é omitido (o padrão é "agora"), a resposta incluirá uma cauda de dados após data_refreshed_at que está incompleta. Para resultados estáveis em chamadas repetidas, defina ending_at para um valor em ou antes de um data_refreshed_at retornado anteriormente.

Limites de intervalo de datas

starting_at pode ser até 365 dias no passado, e uma única consulta pode abranger no máximo 31 dias (ending_at - starting_at). Para cobrir um período mais longo, emita várias consultas com janelas adjacentes. Nenhum dado está disponível antes de 2026-01-01.

Paginação

Todos os quatro endpoints de custo e uso são paginados com um cursor opaco. A primeira solicitação retorna até linhas de limite mais um cursor next_page; passe esse cursor inalterado como parâmetro de página na próxima solicitação e repita até que has_more seja falso.

Trate next_page como opaco: passe-o inalterado na próxima solicitação e envie os mesmos parâmetros de consulta em cada página. Se uma solicitação retornar 400 ou 410 com uma mensagem sobre o cursor de página, descarte-o e comece novamente na primeira página.

Não altere os parâmetros de consulta no meio da sequência. Os cursores estão vinculados aos filtros e intervalo de datas que os emitiram. Se você alterar products[], order_by, group_by[], o intervalo de datas ou qualquer filtro e passar um cursor antigo, você receberá um erro 400.

Serializando parâmetros de lista

Os parâmetros de lista usam notação de colchetes: repita o nome do parâmetro com [] para cada valor.

products[]=chat&products[]=claude_code

O objeto Actor

Cada linha de resultado por usuário identifica o usuário que gerou o uso.

{
"type": "user_actor",
"user_id": "user_01AbCdEfGh",
"name": "Jane Smith",
"email": "[email protected]"
}

Campo

Tipo

Descrição

tipo

string

Sempre "user_actor".

user_id

string

A ID do usuário. Mesmo valor aceito por user_ids[].

nome

string ou null

O nome do usuário. "Usuário Deletado" se o usuário foi deletado.

email

string ou null

O endereço de email do usuário. Nulo quando o usuário é deletado.

deletado

boolean

Verdadeiro se a conta foi deletada.

6. Uso de tokens por usuário

GET /v1/organizations/analytics/user_usage_report

Retorna uso de tokens por usuário em um intervalo de datas, classificado pela métrica de token escolhida.

Parâmetros de consulta

Campo

Tipo

Obrigatório

Padrão

Descrição

starting_at

RFC 3339 datetime

Sim

Início do intervalo, inclusivo. Arredondado para o início da hora em UTC. Deve estar nos últimos 365 dias.

ending_at

RFC 3339 datetime

Não

agora

Fim do intervalo, exclusivo. O intervalo pode abranger no máximo 31 dias.

products[]

um ou mais de chat, claude_code, cowork, office_agent, claude_in_chrome, claude_design

Não

todos os produtos baseados em assentos

Apenas superfícies de produtos baseados em assentos. Repita o parâmetro para múltiplos valores.

models[]

string, máx 100 entradas

Não

todos

Filtrar para nomes de modelos específicos (ex: claude-opus-4-6, claude-sonnet-4-6, claude-haiku-4-5-20251001).

user_ids[]

string, máx 100 entradas

Não

todos

Filtrar para usuários específicos. Útil para procurar um conjunto conhecido de usuários sem paginar toda a organização.

context_windows[]

um ou mais de 0-200k, 200k-1M

Não

todos

Filtrar para camadas de preço de contexto específicas. Use group_by[]=context_window para separar valores por camada.

inference_geos[]

um ou mais de global, us, not_available

Não

todos

Filtrar para regiões de inferência específicas. not_available corresponde a linhas onde a região não está definida. Use group_by[]=inference_geo para separar valores por região.

speeds[]

um ou mais de fast, standard

Não

todos

Filtrar para modo de inferência rápido ou padrão. Use group_by[]=speed para separar valores por modo.

group_by[]

um ou mais de product, model, context_window, inference_geo, speed

Não

nenhum

Separar cada linha do usuário pelas dimensões fornecidas. Com dimensões presentes, um usuário pode abranger várias linhas.

order_by

total_tokens, output_tokens, uncached_input_tokens

Não

total_tokens

Métrica para ordenar.

exclude_deleted_users

booleano

Não

falso

Quando verdadeiro, linhas de usuários deletados são omitidas.

order

desc, asc

Não

desc

Direção de classificação.

limit

inteiro 1–1000

Não

20

Linhas por página.

página

string de cursor opaco

Não

O valor next_page de uma resposta anterior.

Campos de resposta

Campo

Descrição

organization_id

ID da organização à qual a chave de API pertence.

data

Array de entradas, ordenadas por order_by na direção de ordem.

data[].actor

O objeto Actor do usuário que gerou o uso.

data[].product

Quando group_by[] inclui product, a superfície do produto. Caso contrário, null.

data[].model

Quando group_by[] inclui model, o nome do modelo. Caso contrário, null.

data[].context_window

Quando group_by[] inclui context_window, o nível de contexto (0-200k ou 200k-1M). Caso contrário, null.

data[].inference_geo

Quando group_by[] inclui inference_geo, a região de inferência. Caso contrário, null.

data[].speed

Quando group_by[] inclui speed: fast ou standard. Caso contrário, null.

data[].uncached_input_tokens

Tokens de entrada que não foram servidos do cache de prompt.

data[].cache_creation.ephemeral_5m_input_tokens

Tokens escritos no cache de prompt de 5 minutos.

data[].cache_creation.ephemeral_1h_input_tokens

Tokens escritos no cache de prompt de 1 hora.

data[].cache_read_input_tokens

Tokens de entrada servidos do cache de prompt.

data[].output_tokens

Tokens de saída gerados.

data[].total_tokens

Soma de todos os componentes de token acima. A ordem padrão order_by=total_tokens classifica neste valor.

data[].server_tool_use.web_search_requests

Número de chamadas de ferramenta de busca na web.

data[].requests

Número de solicitações de API

has_more

Se outra página existe.

next_page

Cursor opaco para a próxima página; null quando has_more é false.

data_refreshed_at

Timestamp da exportação de dados da qual esta resposta foi servida.

Exemplo de solicitação

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. Custo por usuário

GET /v1/organizations/analytics/user_cost_report

Retorna custo em USD por usuário em um intervalo de datas, ordenado por valor com desconto ou preço de tabela.

Parâmetros de consulta

Igual a user_usage_report, com estas diferenças:

Campo

Tipo

Obrigatório

Padrão

Descrição

order_by

amount, list_amount

Não

amount

Métrica para ordenar por.

group_by[]

um ou mais de product, model, context_window, inference_geo, speed, cost_type, token_type

Não

nenhum

Divida cada linha do usuário pelas dimensões fornecidas. cost_type retorna uma linha por componente de custo (tokens, web search, code execution); token_type retorna uma linha por tipo de token.

Todos os outros parâmetros (starting_at, ending_at, products[], models[], user_ids[], order, limit, page) são idênticos.

Campos de resposta

Campo

Descrição

organization_id

ID da organização à qual a chave de API pertence.

data

Array de entradas, ordenadas por order_by na direção da ordem.

data[].actor

O objeto Actor do usuário que gerou o custo.

data[].product, data[].model, data[].context_window, data[].inference_geo, data[].speed

Quando o valor group_by[] correspondente está definido, o valor da dimensão. Caso contrário, nulo.

data[].currency

Sempre "USD".

data[].amount

Valor em centavos fracionários — custo de consumo bruto após descontos negociados. Por exemplo, "41280.000000" é $412,80. O valor é somado em todos os produtos no filtro products[].

data[].list_amount

Valor de preço de tabela (pré-desconto) em centavos fracionários, mesmo formato.

data[].cost_type

Quando group_by[] inclui cost_type: um de tokens, web_search, code_execution. nulo quando não definido.

data[].token_type

Quando group_by[] inclui token_type: um de uncached_input_tokens, output_tokens, cache_read_input_tokens, cache_creation.ephemeral_5m_input_tokens, cache_creation.ephemeral_1h_input_tokens. Apenas não nulo em linhas onde cost_type é tokens.

data[].requests

Número de solicitações de API

has_more

Se outra página existe.

next_page

Cursor opaco para a próxima página.

data_refreshed_at

Timestamp da exportação de dados de que esta resposta foi servida.

Analisando valores

amount e list_amount são strings decimais denominadas em centavos. "41280.000000" representa 41.280 centavos (US $412,80). Para converter para dólares, analise como decimal e divida por 100. Evite análise de ponto flutuante binário para valores que podem exceder vários milhões de dólares.

Exemplo de solicitação

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. Uso de tokens ao longo do tempo

GET /v1/organizations/analytics/usage_report

Retorna uso de tokens ao longo do tempo, agrupado por minuto, hora ou dia, opcionalmente dividido por produto, modelo, janela de contexto, região de inferência ou velocidade.

Parâmetros de consulta

Campo

Tipo

Obrigatório

Padrão

Descrição

starting_at

Data e hora RFC 3339

Sim

Início do intervalo, inclusivo. Deve estar nos últimos 365 dias. Arredondado para o limite bucket_width mais próximo em UTC.

ending_at

Data e hora RFC 3339

Não

agora

Fim do intervalo, exclusivo. O intervalo pode abranger no máximo 31 dias. Arredondado para o limite bucket_width mais próximo em UTC.

bucket_width

1m, 1h, 1d

Não

1d

Granularidade do bucket de tempo: minuto, hora ou dia.

group_by[]

um ou mais de product, model, context_window, inference_geo, speed

Não

nenhum

Dimensões para dividir dentro de cada bucket. Omita para um único agregado por bucket.

products[]

um ou mais de chat, claude_code, cowork, office_agent, claude_in_chrome, claude_design

Não

todos

Filtrar para superfícies de produto específicas.

models[]

string, máximo 100 entradas

Não

todos

Filtrar para nomes de modelo específicos.

context_windows[]

um ou mais de 0-200k, 200k-1M

Não

todos

Filtrar para camadas de preço de janela de contexto específicas. Use group_by[]=context_window para dividir valores por camada.

inference_geos[]

um ou mais de global, us, not_available

Não

todos

Filtrar para regiões de inferência específicas. not_available corresponde a linhas onde a região não está definida. Use group_by[]=inference_geo para dividir valores por região.

speeds[]

um ou mais de rápido, padrão

Não

todos

Filtrar para modo de inferência rápido ou padrão.

user_ids[]

string, máx 100 entradas

Não

todos

Filtrar para usuários específicos.

limit

inteiro

Não

varia

Buckets por página. Padrão e máximo variam por bucket_width: 1d → 7 (máx 31); 1h → 24 (máx 168); 1m → 60 (máx 256).

página

string de cursor opaco

Não

O valor next_page de uma resposta anterior.

Campos de resposta

Campo

Descrição

organization_id

ID da organização à qual a chave de API pertence.

data

Array de entradas, uma por bucket de tempo.

data[].starting_at

Início do bucket.

data[].ending_at

Fim do bucket.

data[].results

Array de entradas, uma por grupo dentro do bucket. Uma única entrada com todos os campos de dimensão nulos quando group_by[] é omitido.

data[].results[].product, .model, .context_window, .inference_geo, .speed

Quando o valor group_by[] correspondente é definido, o valor da dimensão. Caso contrário, nulo.

data[].results[].uncached_input_tokens

Tokens de entrada que não foram servidos do cache de prompt.

data[].results[].cache_creation.ephemeral_5m_input_tokens

Tokens escritos no cache de prompt de 5 minutos.

data[].results[].cache_creation.ephemeral_1h_input_tokens

Tokens escritos no cache de prompt de 1 hora.

data[].results[].cache_read_input_tokens

Tokens de entrada servidos do cache de prompt.

data[].results[].output_tokens

Tokens de saída gerados.

data[].results[].server_tool_use.web_search_requests

Número de chamadas de ferramenta de busca na web.

has_more

Se mais buckets existem.

next_page

Cursor opaco para a próxima página.

data_refreshed_at

Carimbo de data/hora da exportação de dados de que esta resposta foi servida.

Exemplo de solicitação

--header "x-api-key: $YOUR_API_KEY"

9. Custo ao longo do tempo

GET /v1/organizations/analytics/cost_report

Retorna custo em USD ao longo do tempo, dividido em buckets e agrupado da mesma forma que usage_report.

Parâmetros de consulta

Igual a usage_report (bucket_width, group_by[], filters, limit, page). Os valores de group_by[] também aceitam cost_type e token_type neste endpoint.

Campos de resposta

Campo

Descrição

organization_id

ID da organização à qual a chave de API pertence.

data

Array de entradas, uma por bucket de tempo.

data[].starting_at

Início do bucket.

data[].ending_at

Fim do bucket.

data[].results

Array de entradas, uma por grupo dentro do bucket.

data[].results[].product, .model, .context_window, .inference_geo, .speed

Quando o valor de group_by[] correspondente é definido, o valor da dimensão. Caso contrário, nulo.

data[].results[].cost_type

Quando group_by[] inclui cost_type: tokens, web_search ou code_execution. nulo quando não definido.

data[].results[].token_type

Quando group_by[] inclui token_type: um dos tipos de token listados no endpoint 7. Apenas endpoint de custo — token_type é rejeitado em usage_report.

data[].results[].currency

Sempre "USD".

data[].results[].amount

Valor em centavos fracionários — custo de consumo bruto após descontos negociados.

data[].results[].list_amount

Valor de preço de tabela (pré-desconto) em centavos fracionários.

has_more

Se mais buckets existem.

next_page

Cursor opaco para a próxima página.

data_refreshed_at

Carimbo de data/hora da exportação de dados de que esta resposta foi servida.

Exemplo de solicitação

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"
Isto respondeu à sua pergunta?