Ir para conteúdo principal

Guia de referência da API Claude Enterprise Analytics

Atualizado hoje

Visão geral

A API Claude Enterprise Analytics oferece à sua organização acesso programático aos dados de engajamento para uso de Claude e Claude Code dentro de sua organização Enterprise. Seja construindo painéis internos para atividade de usuários ou rastreando adoção de projetos, esta API fornece as métricas agregadas 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 mais.

Habilitando acesso

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

Alguns detalhes adicionais que podem ser úteis:

  • Você pode habilitar/desabilitar o acesso à API pública a qualquer momento. Se você desabilitar 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 múltiplas 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 . Veja a seção "Rate limiting" 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 header 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 API Keys.

Exemplo de headers 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 de volta em sua próxima solicitação para recuperar a página seguinte 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.

Rate limiting

Temos limites de taxa padrão em vigor. Se isso não for suficiente para seu caso de uso, gostaríamos de entender por quê. 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 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

inteiro

Não

Número de registros por página (padrão: 20, máx: 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 usuário)

Campo

Descrição

user.id

Identificador único para o usuário.

user.email_address

O endereço de email do usuário.

chat_metrics.distinct_conversation_count

Número de conversas distintas, especificamente dentro do Claude.ai.

chat_metrics.message_count

Total de mensagens enviadas, especificamente dentro do Claude.ai.

chat_metrics.distinct_projects_created_count

Número de projetos criados, especificamente dentro do Claude.ai.

chat_metrics.distinct_projects_used_count

Número de projetos distintos usados, especificamente dentro do Claude.ai.

chat_metrics.distinct_files_uploaded_count

Número de arquivos enviados, especificamente dentro do Claude.ai.

chat_metrics.distinct_artifacts_created_count

Número de artefatos criados, especificamente dentro do Claude.ai.

chat_metrics.thinking_message_count

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

chat_metrics.distinct_skills_used_count

Número de skills distintos usados, especificamente dentro do Claude.ai.

chat_metrics.connectors_used_count

Número total de conectores invocados, especificamente dentro do 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 criadas 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 aceitas e rejeitadas para a ferramenta Edit.

claude_code_metrics.tool_actions.multi_edit_tool

Contagens aceitas e rejeitadas para a ferramenta Multi-Edit.

claude_code_metrics.tool_actions.write_tool

Contagens aceitas e rejeitadas para a ferramenta Write.

claude_code_metrics.tool_actions.notebook_edit_tool

Contagens aceitas e rejeitadas para a ferramenta Notebook Edit.

web_search_count

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

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 atividade

GET /v1/organizations/analytics/summaries

Retorna um resumo de alto nível de engajamento e utilização de assentos por dia para sua organização para 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 de 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 um dos seguintes for verdadeiro:

  • 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 a qual recuperar dados, no formato YYYY-MM-DD. Há um atraso de três dias na disponibilidade de 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 a qual 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 de 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 (baseado 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 de projeto de chat

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

Retorna dados de uso divididos por projeto de chat para uma data fornecida. 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 de 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áx: 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 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 fornecida.

distinct_conversation_count

Número de conversas neste projeto na data fornecida.

message_count

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

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 skills

GET /v1/organizations/analytics/skills

Retorna dados de uso de skills em Claude (chat) e Claude Code dentro de sua organização para uma data fornecida. Cada item representa um skill e mostra quantos usuários únicos o usaram.

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 de 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áx: 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 skill)

Campo

Descrição

skill_name

O nome do skill.

distinct_user_count

Número de usuários únicos que usaram este skill na data fornecida.

chat_metrics.distinct_conversation_skill_used_count

Número de conversas distintas nas quais o skill foi usado pelo menos uma vez, em chat.

claude_code_metrics.distinct_session_skill_used_count

Número de sessões remotas distintas nas quais o skill foi usado pelo menos uma vez, em Claude Code.

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

Isto respondeu à sua pergunta?