​
Übersicht

Die Windsurf Analytics-API ermöglicht Enterprise-Kunden den programmgesteuerten Zugriff auf detaillierte Nutzungsdaten für ihre Teams. Sie können Daten aus Autocomplete, Chat, Command und Cascade mit flexiblen Filter-, Gruppierungs- und Aggregationsoptionen abfragen.
Die Analytics-API ist nur für Enterprise-Pläne verfügbar
Die API-Daten werden alle 3 Stunden aktualisiert

​
Basis-URL

Alle API-Anfragen sollten an Folgendes gesendet werden: 
https://server.codeium.com/api/v1/

​
Authentifizierung

Die Analytics-API verwendet Service Keys für die Authentifizierung. Service Keys müssen im Request-Body aller API-Aufrufe enthalten sein.

​
Einen Service-Schlüssel erstellen

  1. Navigieren Sie zu Ihrer Team-Einstellungsseite
  2. Öffnen Sie den Bereich „Service-Schlüssel“
  3. Erstellen Sie einen neuen Service-Schlüssel mit den passenden Berechtigungen
  4. Kopieren Sie den generierten Service-Schlüssel zur Verwendung in API-Anfragen

​
Erforderliche Berechtigungen

Alle Analytics-API-Endpunkte erfordern die Berechtigung „Teams Nur-Lesen“.

​
Verwendung von Service-Schlüsseln

Fügen Sie Ihren Service Key in den Request-Body aller API-Aufrufe ein: 
{
  "service_key": "your_service_key_here",
  // ... andere Parameter
}
Bewahren Sie Ihre Service Keys sicher auf und geben Sie sie niemals in clientseitigem Code oder öffentlichen Repositories preis

​
Gemeinsame Parameter

Die meisten Analytics-API-Endpunkte unterstützen diese allgemeinen Parameter:
ParameterTypErforderlichBeschreibung
service_keystringJaIhr Service Key zur Authentifizierung
group_namestringNeinErgebnisse auf eine bestimmte Gruppe beschränken
start_timestampstringUnterschiedlichStartzeit im RFC 3339-Format (z. B. 2023-01-01T00:00:00Z)
end_timestampstringUnterschiedlichEndzeit im RFC 3339-Format (z. B. 2023-12-31T23:59:59Z)

​
Verfügbare Endpunkte

Die Analytics-API stellt drei Hauptendpunkte bereit:
  1. User Page Analytics - Abrufen von Nutzungsdaten zur Benutzeraktivität von der Teams-Seite
  2. Cascade Analytics - Abfragen von Cascade-spezifischen Nutzungsmetriken
  3. Custom Analytics - Flexible Abfragen mit benutzerdefinierten selections, Filtern und aggregations

​
Rate Limits

API-Anfragen unterliegen Rate Limits, um die Stabilität des Dienstes sicherzustellen. Wenn Sie das Rate Limit überschreiten, erhalten Sie eine Antwort mit 429 Too Many Requests.

​
Support

Bei Support- oder API-Fragen wenden Sie sich bitte an den Windsurf Support.