​
Übersicht

Die Windsurf Analytics-API ermöglicht Enterprise-Kund:innen den programmatischen Zugriff auf detaillierte Nutzungs-Analytics für ihre Teams. Stellen Sie Abfragen zu Daten aus Autocomplete, Chat, Command und Cascade mit flexiblen Filter-, Gruppierungs- und Aggregationsoptionen.
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 zur Authentifizierung. Service Keys müssen im Anfragetext aller API-Aufrufe enthalten sein.

​
Einen Service-Schlüssel erstellen

  1. Navigieren Sie zu Ihrer Team-Einstellungsseite
  2. Gehen Sie zum Abschnitt „Service-Schlüssel“
  3. Erstellen Sie einen neuen Service Key mit den entsprechenden Berechtigungen
  4. Kopieren Sie den generierten Service Key zur Verwendung in API-Anfragen

​
Erforderliche Berechtigungen

Für alle Analytics-API-Endpunkte sind die Berechtigungen „Teams Nur-Lesen“ erforderlich.

​
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 setzen Sie sie niemals in clientseitigem Code oder öffentlichen Repositories aus

​
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_timestampstringVariiertStartzeit im RFC 3339-Format (z. B. 2023-01-01T00:00:00Z)
end_timestampstringVariiertEndzeit 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 - Nutzungsaktivitätsdaten von der Teams-Seite abrufen
  2. Cascade Analytics - Cascade-spezifische Nutzungsmetriken abfragen
  3. Custom Analytics - Flexible Abfragen mit benutzerdefinierten selections, Filtern und aggregations

​
Rate Limits

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

​
Support

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