​
Présentation

L’Analytics API de Windsurf permet aux clients Enterprise d’accéder par programmation à 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 actualisées toutes les 3 heures

​
URL de base

Toutes les requêtes API doivent être adressé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 à l’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 autorisations appropriées
  4. Copiez la clé de service générée pour l’utiliser dans les requêtes d’API

​
Permissions 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
}
Conservez vos clés de service en lieu sûr et ne les exposez jamais dans du code côté client ni dans des dépôts publics

​
Paramètres communs

La plupart des endpoints de l’Analytics API prennent en charge ces paramètres communs :
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 points de terminaison principaux :
  1. User Page Analytics - Récupérez les données d’activité des utilisateurs depuis la page Teams
  2. Cascade Analytics - Interrogez des métriques d’utilisation spécifiques à Cascade
  3. Custom Analytics - Requête flexible avec des selections, filtres et aggregations personnalisés

​
Limites de taux

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

​
Support

Pour toute question ou assistance liée à l’API, veuillez contacter le support Windsurf.