Salt la conținutul principal

​
Prezentare generală

Windsurf Analytics API le permite clienților Enterprise să acceseze programatic statistici detaliate de utilizare pentru echipele lor. Interogați date din Autocomplete, Chat, funcțiile Command și Cascade, cu opțiuni flexibile de filtrare, grupare și agregare.
Analytics API este disponibilă doar pentru planurile Enterprise
Datele API sunt actualizate la fiecare 3 ore

​
URL de bază

Toate cererile către API trebuie trimise la: 
https://server.codeium.com/api/v1/

​
Autentificare

Analytics API folosește chei de serviciu pentru autentificare. Cheile de serviciu trebuie incluse în corpul solicitării pentru toate apelurile API.

​
Crearea unei chei de serviciu

  1. Navigați la pagina setărilor echipei
  2. Accesați secțiunea „Chei de serviciu”
  3. Creați o nouă cheie de serviciu cu permisiunile corespunzătoare
  4. Copiați cheia de serviciu generată pentru a o folosi în solicitările API

​
Permisiuni necesare

Toate endpointurile Analytics API necesită permisiuni „Teams Read‑only”.

​
Utilizarea cheilor de serviciu

Includeți cheia de serviciu în corpul solicitării pentru toate apelurile API: 
{
  "service_key": "your_service_key_here",
  // ... alți parametri
}
Păstrați cheile de serviciu în siguranță și nu le expuneți niciodată în codul clientului sau în repozitoare publice

​
Parametri comuni

Majoritatea endpointurilor Analytics API acceptă acești parametri comuni:
ParameterTypeRequiredDescription
service_keystringDaCheia de serviciu pentru autentificare
group_namestringNuFiltrați rezultatele pentru un anumit grup
start_timestampstringVariabilTimpul de început în format RFC 3339 (de ex., 2023-01-01T00:00:00Z)
end_timestampstringVariabilTimpul de sfârșit în format RFC 3339 (de ex., 2023-12-31T23:59:59Z)

​
Endpointuri disponibile

Analytics API oferă trei endpointuri principale:
  1. User Page Analytics - Obține date despre activitatea utilizatorilor din pagina Teams
  2. Cascade Analytics - Interoghează metrice de utilizare specifice Cascade
  3. Custom Analytics - Interogări flexibile cu selections personalizate, filtre și agregations

​
Limitări de rată

Solicitările către API sunt supuse unor limite de rată pentru a asigura stabilitatea serviciului. Dacă depășiți limita, veți primi un răspuns 429 Too Many Requests.

​
Asistență

Pentru asistență și întrebări legate de API, contactați Windsurf Support.
⌘I