Passer au contenu principal

Guide de référence de l'API Claude Enterprise Analytics

Mis à jour aujourd’hui

Aperçu

L'API Claude Enterprise Analytics donne à votre organisation un accès programmatique aux données d'engagement pour l'utilisation de Claude et Claude Code au sein de votre organisation Enterprise. Que vous construisiez des tableaux de bord internes pour l'activité des utilisateurs ou que vous suiviez l'adoption de projets, cette API fournit les métriques agrégées dont vous avez besoin.

Agrégation des données

Toutes les données sont agrégées par organisation, par jour. Chaque endpoint retourne un snapshot pour une seule date que vous spécifiez. Les données du jour (N-1) sont exécutées à 10:00:00 UTC le jour N, et sont disponibles pour interrogation trois jours après l'agrégation, pour assurer l'exactitude des données.

Si les données ne sont pas disponibles dans le délai ci-dessus, cela indique généralement une défaillance du pipeline de données que notre équipe devra enquêter en interne. Nous sommes généralement conscients de tels problèmes, mais veuillez le signaler à votre CSM si vous souhaitez une vérification, ou si vous soupçonnez quelque chose d'autre.

Activation de l'accès

Pour créer de nouvelles clés API d'analyse, vous devez être un propriétaire principal au sein de votre organisation Enterprise. Vous pouvez le faire en naviguant vers claude.ai/analytics/api-keys.

Voici quelques détails supplémentaires qui pourraient être utiles :

  • Vous pouvez activer/désactiver l'accès à l'API publique à tout moment. Si vous désactivez l'accès en basculant le commutateur, toutes les demandes seront refusées.

  • Vous aurez besoin d'une clé avec la portée read:analytics pour accéder à l'API. Vous pouvez créer plusieurs clés pour votre organisation, mais les limites de débit s'appliquent au niveau de l'organisation , pas au niveau de la clé . Voir la section « Limitation du débit » ci-dessous.

  • Comme toujours, nous recommandons fortement de gérer les clés API de manière sécurisée : ne partagez jamais ces clés publiquement - elles sont secrètes et doivent être partagées de manière sécurisée.

URL de base

Toutes les demandes sont envoyées à :

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

Authentification

Chaque demande nécessite une clé API transmise dans l'en-tête x-api-key. Votre clé API doit avoir la portée read:analytics. Vous pouvez créer et gérer les clés API à partir des paramètres d'administration de claude.ai sous la section Clés API.

Exemple d'en-têtes de demande :

x-api-key: $YOUR_API_KEY

Pagination

Plusieurs endpoints retournent des résultats paginés. La pagination utilise une approche basée sur les curseurs, où la réponse inclut un jeton next_page que vous transmettez dans votre demande suivante pour récupérer la page de résultats suivante.

Deux paramètres optionnels contrôlent la pagination :

limit (entier) : Nombre d'enregistrements par page. Par défaut 20 pour l'endpoint /users et 100 pour tous les autres endpoints. Le maximum est 1000.

page (chaîne) : Le jeton de curseur opaque du champ next_page de la réponse précédente. Omettez ceci lors de votre première demande.

Quand il n'y a plus de résultats, next_page sera null dans la réponse.

Réponses d'erreur

Tous les endpoints retournent des codes d'erreur HTTP standard :

Code

Signification

400

Un paramètre de requête est invalide. Les causes courantes incluent une date invalide, une date antérieure à 1/1/26 (première disponibilité), ou une date qui est aujourd'hui ou dans le futur. La disponibilité des données est retardée de trois jours.

404

La clé API est manquante, invalide, ou n'a pas la portée read:analytics.

429

Limite de débit dépassée. Trop de demandes.

503

Défaillance transitoire, veuillez réessayer.

Limitation du débit

Nous avons des limites de débit par défaut en place. Si cela n'est pas suffisant pour votre cas d'usage, nous aimerions comprendre pourquoi. Si nécessaire, nous pouvons ajuster les limites de débit pour votre organisation — veuillez contacter votre CSM.

Endpoints

1. Lister l'activité des utilisateurs

GET /v1/organizations/analytics/users

Retourne les métriques d'engagement par utilisateur pour un seul jour. Chaque élément de la réponse représente un utilisateur et inclut ses comptages d'activité sur Claude (chat) et Claude Code.

Paramètres de requête

Champ

Type

Requis

Description

date

chaîne

Oui

La date pour laquelle récupérer les métriques, au format YYYY-MM-DD.

limit

entier

Non

Nombre d'enregistrements par page (par défaut : 20, max : 1000).

page

chaîne

Non

Jeton de curseur du champ next_page d'une réponse précédente pour récupérer la page suivante.

Champs de réponse (par utilisateur)

Champ

Description

user.id

Identifiant unique pour l'utilisateur.

user.email_address

L'adresse e-mail de l'utilisateur.

chat_metrics.distinct_conversation_count

Nombre de conversations distinctes, spécifiquement dans Claude.ai.

chat_metrics.message_count

Nombre total de messages envoyés, spécifiquement dans Claude.ai.

chat_metrics.distinct_projects_created_count

Nombre de projets créés, spécifiquement dans Claude.ai.

chat_metrics.distinct_projects_used_count

Nombre de projets distincts utilisés, spécifiquement dans Claude.ai.

chat_metrics.distinct_files_uploaded_count

Nombre de fichiers téléchargés, spécifiquement dans Claude.ai.

chat_metrics.distinct_artifacts_created_count

Nombre d'artefacts créés, spécifiquement dans Claude.ai.

chat_metrics.thinking_message_count

Nombre de messages de réflexion (étendus), spécifiquement dans Claude.ai.

chat_metrics.distinct_skills_used_count

Nombre de compétences distinctes utilisées, spécifiquement dans Claude.ai.

chat_metrics.connectors_used_count

Nombre total de connecteurs invoqués, spécifiquement dans Claude.ai.

claude_code_metrics.core_metrics.commit_count

Nombre de commits git effectués via Claude Code.

claude_code_metrics.core_metrics.pull_request_count

Nombre de demandes de tirage créées via Claude Code.

claude_code_metrics.core_metrics.lines_of_code.added_count

Nombre total de lignes de code ajoutées.

claude_code_metrics.core_metrics.lines_of_code.removed_count

Nombre total de lignes de code supprimées.

claude_code_metrics.core_metrics.distinct_session_count

Nombre de sessions Claude Code distinctes.

claude_code_metrics.tool_actions.edit_tool

Comptages acceptés et rejetés pour l'outil Edit.

claude_code_metrics.tool_actions.multi_edit_tool

Comptages acceptés et rejetés pour l'outil Multi-Edit.

claude_code_metrics.tool_actions.write_tool

Comptages acceptés et rejetés pour l'outil Write.

claude_code_metrics.tool_actions.notebook_edit_tool

Comptages acceptés et rejetés pour l'outil Notebook Edit.

web_search_count

Total des invocations de l'outil de recherche web. Cela s'applique à la fois à l'utilisation de claude.ai et de claude code au sein de votre organisation.

Exemple de demande

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. Résumé d'activité

GET /v1/organizations/analytics/summaries

Retourne un résumé de haut niveau de l'engagement et de l'utilisation des sièges par jour pour votre organisation pour une plage de dates donnée. La réponse est une liste de jours avec des comptages agrégés dans la plage de dates. Notez que la différence maximale entre ending_date et starting_date doit être 31 jours, et il y a un délai de trois jours dans la disponibilité des données. Ceci est utile pour suivre les utilisateurs actifs quotidiens, les tendances hebdomadaires et mensuelles, et l'allocation des sièges en un coup d'œil.

Nous définissons « actif » si l'une des conditions suivantes est vraie :

  • L'utilisateur a envoyé au moins un message de chat sur Claude (chat).

  • L'utilisateur a eu au moins une session Claude Code (locale ou distante) associée à l'organisation C4E, avec utilisation d'outils/activité git

Paramètres de requête

Champ

Type

Requis

Description

starting_date

chaîne

Oui

La date de début pour laquelle récupérer les données, au format YYYY-MM-DD. Il y a un délai de trois jours dans la disponibilité des données, donc les données les plus récentes auxquelles vous pouvez accéder sont d'il y a trois jours.

ending_date

chaîne

Non

La date de fin optionnelle pour laquelle récupérer les données, au format YYYY-MM-DD. Ceci est exclusif.

Champs de réponse

Champ

Description

starting_date

Premier jour pour lequel les métriques sont agrégées, interprété comme une date UTC. Il y a un délai de trois jours dans la disponibilité des données, donc les données les plus récentes auxquelles vous pouvez accéder sont d'il y a trois jours.

ending_date

Dernier jour (exclusif) pour lequel les métriques sont agrégées, interprété comme une date UTC

daily_active_user_count

Nombre d'utilisateurs actifs à la date spécifiée (basé sur la consommation de tokens).

weekly_active_user_count

Nombre d'utilisateurs actifs dans la fenêtre glissante de 7 jours se terminant à la date spécifiée.

monthly_active_user_count

Nombre d'utilisateurs actifs dans la fenêtre glissante de 30 jours se terminant à la date spécifiée.

assigned_seat_count

Nombre total de sièges actuellement assignés dans votre organisation.

pending_invite_count

Nombre d'invitations en attente qui n'ont pas encore été acceptées.

Remarque : Les fenêtres glissantes pour les comptages hebdomadaires et mensuels regardent vers l'arrière à partir de la date spécifiée (incluse). Si les données sont incomplètes pour certains jours dans la fenêtre (par exemple, si la date est inférieure à 30 jours dans le passé), le comptage mensuel peut sous-estimer l'activité.

Exemple de demande

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

3. Utilisation des projets de chat

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

Retourne les données d'utilisation ventilées par projet de chat pour une date donnée. Les projets sont spécifiques à Claude (chat), donc cet endpoint se concentre sur cette surface. Chaque élément affiche le nom du projet, le nombre d'utilisateurs uniques qui ont interagi avec lui, et le nombre total de conversations tenues dans ce projet.

Paramètres de requête

Champ

Type

Requis

Description

date

chaîne

Oui

La date pour laquelle récupérer les métriques, au format YYYY-MM-DD. Il y a un délai de trois jours dans la disponibilité des données, donc les données les plus récentes auxquelles vous pouvez accéder sont d'il y a trois jours.

limit

entier

Non

Nombre d'enregistrements par page (par défaut : 100, max : 1000).

page

chaîne

Non

Jeton de curseur du champ next_page d'une réponse précédente pour récupérer la page suivante.

Champs de réponse (par projet)

Champ

Description

project_name

Le nom du projet.

project_id

L'identifiant du projet balisé, c'est-à-dire « claude_proj_{ID} »

distinct_user_count

Nombre d'utilisateurs uniques qui ont utilisé ce projet à la date donnée.

distinct_conversation_count

Nombre de conversations dans ce projet à la date donnée.

message_count

Nombre total de messages envoyés dans ce projet à la date donnée.

Exemple de demande

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. Utilisation des compétences

GET /v1/organizations/analytics/skills

Retourne les données d'utilisation des compétences sur Claude (chat) et Claude Code au sein de votre organisation pour une date donnée. Chaque élément représente une compétence et affiche le nombre d'utilisateurs uniques qui l'ont utilisée.

Paramètres de requête

Champ

Type

Requis

Description

date

chaîne

Oui

La date pour laquelle récupérer les métriques, au format YYYY-MM-DD. Il y a un délai de trois jours dans la disponibilité des données, donc les données les plus récentes auxquelles vous pouvez accéder sont d'il y a trois jours.

limit

entier

Non

Nombre d'enregistrements par page (par défaut : 100, max : 1000).

page

chaîne

Non

Jeton de curseur du champ next_page d'une réponse précédente pour récupérer la page suivante.

Champs de réponse (par compétence)

Champ

Description

Avez-vous trouvé la réponse à votre question ?