Guia de referência da API Claude Enterprise Analytics

Visão geral

A API Claude Enterprise Analytics oferece à sua organização acesso programático aos dados de engajamento do Claude e Claude Code dentro da sua organização Enterprise. Quer você esteja criando painéis internos para atividade de usuários ou rastreando a adoção de projetos, esta API fornece as métricas agregadas de que você precisa.

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.

Habilitando acesso

Para criar novas chaves de API de análise, você deve ser um Proprietário Primário dentro da 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 a chave, 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. 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.

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) ou uma data que é hoje ou no futuro. A disponibilidade de dados é atrasada em três dias.
404	A chave de API está ausente, inválida ou não possui o escopo `read:analytics`.
429	Limite de taxa excedido. Muitas solicitações.
503	Falha transitória, tente novamente.

Limitação de taxa

Temos limites de taxa padrão em vigor. 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

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 no Claude (chat) e Claude Code.

Parâmetros de consulta

Campo	Tipo	Obrigatório	Descrição
`date`	string	Sim	A data para recuperar métricas, no formato YYYY-MM-DD.
`limit`	inteiro	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` 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 email 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 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 enviados, especificamente no Claude.ai.
`chat_metrics.distinct_artifacts_created_count`	Número de artefatos criados, 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.
`claude_code_metrics.core_metrics.commit_count`	Número de commits 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 Edit.
`claude_code_metrics.tool_actions.multi_edit_tool`	Contagens de aceitos e rejeitados para a ferramenta Multi-Edit.
`claude_code_metrics.tool_actions.write_tool`	Contagens de aceitos e rejeitados para a ferramenta Write.
`claude_code_metrics.tool_actions.notebook_edit_tool`	Contagens de aceitos e rejeitados para a ferramenta Notebook Edit.
`web_search_count`	Total de invocações da ferramenta de busca na web. Isso se aplica tanto a claude.ai quanto ao uso de código Claude 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 zerados 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.

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 fornecido. 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

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.

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 Chat

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

Retorna dados de uso divididos por projeto de chat para uma data especificada. 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 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 de um campo `next_page` de uma resposta anterior 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 da 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`	integer	Não	Número de registros por página (padrão: 100, máximo: 1000).
`page`	string	Não	Token de cursor de uma resposta anterior's `next_page` campo 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 utilizaram esta habilidade na data especificada.
`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.

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 da sua organização para uma data específica. Cada item representa um conector e mostra quantos usuários únicos o utilizaram. 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 da resposta anterior's `next_page` campo 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 fornecida.
`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 a habilidade foi usada 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 zero.

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.

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"