Zum Hauptinhalt springen

Claude Enterprise Analytics API-Referenzhandbuch

Heute aktualisiert

Übersicht

Die Claude Enterprise Analytics API bietet Ihrer Organisation programmgesteuerten Zugriff auf Engagement-Daten für Claude und Claude Code-Nutzung innerhalb Ihrer Enterprise-Organisation. Ob Sie interne Dashboards für Benutzeraktivitäten erstellen oder die Einführung von Projekten verfolgen – diese API bietet die aggregierten Metriken, die Sie benötigen.

Datenaggregation

Alle Daten werden pro Organisation und pro Tag aggregiert. Jeder Endpunkt gibt einen Snapshot für ein einzelnes Datum zurück, das Sie angeben. Daten für Tag (N-1) werden um 10:00:00 UTC-Zeit an Tag N ausgeführt und sind drei Tage nach der Aggregation zur Abfrage verfügbar, um die Genauigkeit der Daten zu gewährleisten.

Wenn Daten nicht innerhalb des oben genannten Zeitraums verfügbar sind, deutet dies normalerweise auf einen Fehler in der Datenpipeline hin, den unser Team intern untersuchen muss. Wir sind uns solcher Probleme normalerweise bewusst, aber bitte wenden Sie sich an Ihren CSM, wenn Sie eine Überprüfung wünschen oder etwas anderes vermuten.

Zugriff aktivieren

Um neue Analytics-API-Schlüssel zu erstellen, müssen Sie ein Primary Owner innerhalb Ihrer Enterprise-Organisation sein. Sie können dies tun, indem Sie zu claude.ai/analytics/api-keys navigieren.

Hier sind einige weitere Details, die hilfreich sein könnten:

  • Sie können den Zugriff auf die öffentliche API jederzeit aktivieren/deaktivieren. Wenn Sie den Zugriff durch Ausschalten des Schalters deaktivieren, werden alle Anfragen abgelehnt.

  • Sie benötigen einen Schlüssel mit dem Bereich read:analytics, um auf die API zuzugreifen. Sie können mehrere Schlüssel für Ihre Organisation erstellen, aber Ratenlimits gelten auf Organisationsebene, nicht auf Schlüsselebene. Siehe den Abschnitt „Rate Limiting" unten.

  • Wie immer empfehlen wir dringend, API-Schlüssel sicher zu handhaben: Geben Sie diese Schlüssel niemals öffentlich frei – sie sind geheim und sollten sicher weitergegeben werden.

Basis-URL

Alle Anfragen werden an folgende Adresse gesendet:

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

Authentifizierung

Jede Anfrage erfordert einen API-Schlüssel, der im Header x-api-key übergeben wird. Ihr API-Schlüssel muss den Bereich read:analytics haben. Sie können API-Schlüssel in den claude.ai-Administratoreinstellungen im Abschnitt API-Schlüssel erstellen und verwalten.

Beispiel-Request-Header:

x-api-key: $YOUR_API_KEY

Pagination

Mehrere Endpunkte geben paginierte Ergebnisse zurück. Die Pagination verwendet einen cursor-basierten Ansatz, bei dem die Antwort ein Token next_page enthält, das Sie in Ihrer nächsten Anfrage übergeben, um die nächste Seite mit Ergebnissen abzurufen.

Zwei optionale Parameter steuern die Pagination:

limit (integer): Anzahl der Datensätze pro Seite. Standard ist 20 für den /users-Endpunkt und 100 für alle anderen Endpunkte. Das Maximum ist 1000.

page (string): Das opaque Cursor-Token aus dem Feld next_page der vorherigen Antwort. Lassen Sie dies bei Ihrer ersten Anfrage weg.

Wenn es keine weiteren Ergebnisse gibt, ist next_page in der Antwort null.

Fehlerantworten

Alle Endpunkte geben Standard-HTTP-Fehlercodes zurück:

Code

Bedeutung

400

Ein Abfrageparameter ist ungültig. Häufige Ursachen sind ein ungültiges Datum, ein Datum vor 1/1/26 (erste Verfügbarkeit) oder ein Datum, das heute oder in der Zukunft liegt. Die Datenverfügbarkeit ist um drei Tage verzögert.

404

Der API-Schlüssel fehlt, ist ungültig oder hat nicht den Bereich read:analytics.

429

Ratenlimit überschritten. Zu viele Anfragen.

503

Vorübergehender Fehler, bitte versuchen Sie es erneut.

Rate Limiting

Wir haben Standard-Ratenlimits eingerichtet. Wenn das für Ihren Anwendungsfall nicht ausreichend ist, würden wir gerne verstehen, warum. Falls erforderlich, können wir die Ratenlimits für Ihre Organisation anpassen – bitte wenden Sie sich an Ihren CSM.

Endpunkte

1. Benutzeraktivität auflisten

GET /v1/organizations/analytics/users

Gibt pro-Benutzer-Engagement-Metriken für einen einzelnen Tag zurück. Jedes Element in der Antwort stellt einen Benutzer dar und enthält seine Aktivitätszählungen über Claude (Chat) und Claude Code.

Abfrageparameter

Feld

Typ

Erforderlich

Beschreibung

date

string

Ja

Das Datum, für das Metriken abgerufen werden sollen, im Format YYYY-MM-DD.

limit

integer

Nein

Anzahl der Datensätze pro Seite (Standard: 20, Max: 1000).

page

string

Nein

Cursor-Token aus dem Feld next_page einer vorherigen Antwort zum Abrufen der nächsten Seite.

Antwortfelder (pro Benutzer)

Feld

Beschreibung

user.id

Eindeutige Kennung für den Benutzer.

user.email_address

Die E-Mail-Adresse des Benutzers.

chat_metrics.distinct_conversation_count

Anzahl der unterschiedlichen Konversationen, speziell innerhalb von Claude.ai.

chat_metrics.message_count

Gesamtzahl der gesendeten Nachrichten, speziell innerhalb von Claude.ai.

chat_metrics.distinct_projects_created_count

Anzahl der erstellten Projekte, speziell innerhalb von Claude.ai.

chat_metrics.distinct_projects_used_count

Anzahl der unterschiedlichen verwendeten Projekte, speziell innerhalb von Claude.ai.

chat_metrics.distinct_files_uploaded_count

Anzahl der hochgeladenen Dateien, speziell innerhalb von Claude.ai.

chat_metrics.distinct_artifacts_created_count

Anzahl der erstellten Artefakte, speziell innerhalb von Claude.ai.

chat_metrics.thinking_message_count

Anzahl der Thinking-(erweiterten) Nachrichten, speziell innerhalb von Claude.ai.

chat_metrics.distinct_skills_used_count

Anzahl der unterschiedlichen verwendeten Skills, speziell innerhalb von Claude.ai.

chat_metrics.connectors_used_count

Gesamtzahl der aufgerufenen Connectors, speziell innerhalb von Claude.ai.

claude_code_metrics.core_metrics.commit_count

Anzahl der Git-Commits über Claude Code.

claude_code_metrics.core_metrics.pull_request_count

Anzahl der über Claude Code erstellten Pull Requests.

claude_code_metrics.core_metrics.lines_of_code.added_count

Gesamtzahl der hinzugefügten Codezeilen.

claude_code_metrics.core_metrics.lines_of_code.removed_count

Gesamtzahl der entfernten Codezeilen.

claude_code_metrics.core_metrics.distinct_session_count

Anzahl der unterschiedlichen Claude Code-Sitzungen.

claude_code_metrics.tool_actions.edit_tool

Akzeptierte und abgelehnte Zählungen für das Edit-Tool.

claude_code_metrics.tool_actions.multi_edit_tool

Akzeptierte und abgelehnte Zählungen für das Multi-Edit-Tool.

claude_code_metrics.tool_actions.write_tool

Akzeptierte und abgelehnte Zählungen für das Write-Tool.

claude_code_metrics.tool_actions.notebook_edit_tool

Akzeptierte und abgelehnte Zählungen für das Notebook Edit-Tool.

web_search_count

Gesamtzahl der Aufrufe des Web-Search-Tools. Dies gilt sowohl für claude.ai als auch für die Claude Code-Nutzung innerhalb Ihrer Organisation.

Beispiel-Request

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. Aktivitätszusammenfassung

GET /v1/organizations/analytics/summaries

Gibt eine allgemeine Zusammenfassung des Engagements und der Sitznutzung pro Tag für Ihre Organisation für einen bestimmten Datumsbereich zurück. Die Antwort ist eine Liste von Tagen mit aggregierten Zählungen innerhalb des Datumsbereichs. Beachten Sie, dass die maximale Differenz zwischen ending_date und starting_date 31 Tage betragen muss, und es gibt eine dreitägige Verzögerung bei der Datenverfügbarkeit. Dies ist nützlich zum Verfolgen täglich aktiver Benutzer, wöchentlicher und monatlicher Trends sowie zur Sitzverteilung auf einen Blick.

Wir definieren „aktiv" wenn eine der folgenden Bedingungen erfüllt ist:

  • Der Benutzer hat mindestens eine Chat-Nachricht auf Claude (Chat) gesendet.

  • Der Benutzer hatte mindestens eine Claude Code-(lokal oder remote) Sitzung, die mit der C4E-Organisation verknüpft ist, mit Tool-Nutzung/Git-Aktivität

Abfrageparameter

Feld

Typ

Erforderlich

Beschreibung

starting_date

string

Ja

Das Startdatum für den Datenabruf im Format YYYY-MM-DD. Es gibt eine dreitägige Verzögerung bei der Datenverfügbarkeit, daher sind die aktuellsten Daten, auf die Sie zugreifen können, von vor drei Tagen.

ending_date

string

Nein

Das optionale Enddatum für den Datenabruf im Format YYYY-MM-DD. Dies ist exklusiv.

Antwortfelder

Feld

Beschreibung

starting_date

Erster Tag, für den Metriken aggregiert werden, interpretiert als UTC-Datum. Es gibt eine dreitägige Verzögerung bei der Datenverfügbarkeit, daher sind die aktuellsten Daten, auf die Sie zugreifen können, von vor drei Tagen.

ending_date

Letzter Tag (exklusiv), für den Metriken aggregiert werden, interpretiert als UTC-Datum

daily_active_user_count

Anzahl der Benutzer, die am angegebenen Datum aktiv waren (basierend auf Token-Verbrauch).

weekly_active_user_count

Anzahl der Benutzer, die innerhalb des 7-Tage-Fensters mit rollierendem Fenster bis zum angegebenen Datum aktiv waren.

monthly_active_user_count

Anzahl der Benutzer, die innerhalb des 30-Tage-Fensters mit rollierendem Fenster bis zum angegebenen Datum aktiv waren.

assigned_seat_count

Gesamtzahl der derzeit in Ihrer Organisation zugewiesenen Sitze.

pending_invite_count

Anzahl der ausstehenden Einladungen, die noch nicht akzeptiert wurden.

Hinweis: Die rollierenden Fenster für wöchentliche und monatliche Zählungen schauen vom angegebenen Datum (einschließlich) rückwärts. Wenn Daten für einige Tage innerhalb des Fensters unvollständig sind (z. B. wenn das Datum weniger als 30 Tage in der Vergangenheit liegt), kann die monatliche Zählung die Aktivität unterschätzen.

Beispiel-Request

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

3. Chat-Projektnutzung

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

Gibt Nutzungsdaten aufgeschlüsselt nach Chat-Projekt für ein bestimmtes Datum zurück. Projekte sind spezifisch für Claude (Chat), daher konzentriert sich dieser Endpunkt auf diese Oberfläche. Jedes Element zeigt den Projektnamen, wie viele eindeutige Benutzer damit interagiert haben, und die Gesamtzahl der in diesem Projekt geführten Konversationen.

Abfrageparameter

Feld

Typ

Erforderlich

Beschreibung

date

string

Ja

Das Datum, für das Metriken abgerufen werden sollen, im Format YYYY-MM-DD. Es gibt eine dreitägige Verzögerung bei der Datenverfügbarkeit, daher sind die aktuellsten Daten, auf die Sie zugreifen können, von vor drei Tagen.

limit

integer

Nein

Anzahl der Datensätze pro Seite (Standard: 100, Max: 1000).

page

string

Nein

Cursor-Token aus dem Feld next_page einer vorherigen Antwort zum Abrufen der nächsten Seite.

Antwortfelder (pro Projekt)

Feld

Beschreibung

project_name

Der Name des Projekts.

project_id

Die gekennzeichnete Projekt-ID, z. B. „claude_proj_{ID}"

distinct_user_count

Anzahl der eindeutigen Benutzer, die dieses Projekt am angegebenen Datum verwendet haben.

distinct_conversation_count

Anzahl der Konversationen in diesem Projekt am angegebenen Datum.

message_count

Gesamtzahl der in diesem Projekt am angegebenen Datum gesendeten Nachrichten.

Beispiel-Request

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. Skill-Nutzung

GET /v1/organizations/analytics/skills

Gibt Skill-Nutzungsdaten über Claude (Chat) und Claude Code innerhalb Ihrer Organisation für ein bestimmtes Datum zurück. Jedes Element stellt einen Skill dar und zeigt, wie viele eindeutige Benutzer ihn verwendet haben.

Abfrageparameter

Feld

Typ

Erforderlich

Beschreibung

date

string

Ja

Das Datum, für das Metriken abgerufen werden sollen, im Format YYYY-MM-DD. Es gibt eine dreitägige Verzögerung bei der Datenverfügbarkeit, daher sind die aktuellsten

Hat dies deine Frage beantwortet?