​
Présentation

L’Analytics API de Windsurf permet aux clients Enterprise d’accéder de manière programmatique à des analyses d’utilisation détaillées pour leurs équipes. Interrogez les données d’Autocomplete, Chat, Command et Cascade avec des options flexibles de filtrage, de regroupement et d’agrégation.
L’Analytics API est disponible uniquement pour les offres Enterprise
Les données de l’API sont mises à jour toutes les 3 heures

​
URL de base

Toutes les requêtes vers l’API doivent être envoyées à : 
https://server.codeium.com/api/v1/

​
Authentification

L’Analytics API utilise des clés de service pour l’authentification. Les clés de service doivent être incluses dans le corps de la requête pour tous les appels API.

​
Création d’une clé de service

  1. Accédez à votre page des paramètres d’équipe
  2. Accédez à la section « Clés de service »
  3. Créez une nouvelle clé de service avec les permissions appropriées
  4. Copiez la clé de service générée pour l’utiliser dans les requêtes API

​
Autorisations requises

Tous les endpoints de l’Analytics API nécessitent l’autorisation « Teams Read-only ».

​
Utilisation des clés de service

Incluez votre clé de service dans le corps de la requête pour tous les appels à l’API : 
{
  "service_key": "votre_service_key_ici",
  // ... autres paramètres
}
Protégez vos clés de service et ne les exposez jamais dans du code côté client ni dans des dépôts publics

​
Paramètres courants

La plupart des endpoints de l’Analytics API prennent en charge ces paramètres courants :
ParamètreTypeObligatoireDescription
service_keystringOuiVotre clé de service pour l’authentification
group_namestringNonFiltrer les résultats sur un groupe spécifique
start_timestampstringVariableHeure de début au format RFC 3339 (p. ex. : 2023-01-01T00:00:00Z)
end_timestampstringVariableHeure de fin au format RFC 3339 (p. ex. : 2023-12-31T23:59:59Z)

​
Points de terminaison disponibles

L’Analytics API propose trois principaux points de terminaison :
  1. User Page Analytics - Récupérez les données d’activité des utilisateurs depuis la page Teams
  2. Cascade Analytics - Interrogez des indicateurs d’utilisation propres à Cascade
  3. Custom Analytics - Requêtes flexibles avec des selections personnalisées, des filtres et des aggregations

​
Limitations de débit

Les requêtes API sont soumises à des limitations de débit afin d’assurer la stabilité du service. Si vous dépassez cette limite, vous recevrez une réponse 429 Too Many Requests.

​
Assistance

Pour toute assistance relative à l’API ou pour toute question, veuillez contacter le support Windsurf.