​
Descripción general

La Analytics API de Windsurf permite a los clientes Enterprise acceder programáticamente a análisis de uso detallados para sus equipos. Consulta datos de Autocomplete, Chat, Command y Cascade con opciones flexibles de filtrado, agrupación y agregación.
La Analytics API está disponible únicamente para planes Enterprise
Los datos de la API se actualizan cada 3 horas

​
URL base

Todas las solicitudes a la API deben realizarse en: 
https://server.codeium.com/api/v1/

​
Autenticación

La Analytics API utiliza claves de servicio para la autenticación. Las claves de servicio deben incluirse en el cuerpo de la solicitud de todas las llamadas a la API.

​
Crear una Clave de servicio

  1. Ve a la página de configuración de tu equipo
  2. Abre la sección “Claves de servicio”
  3. Crea una nueva clave de servicio con los permisos adecuados
  4. Copia la clave de servicio generada para usarla en solicitudes a la API

​
Permisos necesarios

Todos los endpoints de Analytics API requieren el permiso “Teams Read-only”.

​
Uso de Claves de servicio

Incluye tu clave de servicio en el cuerpo de la solicitud de todas las llamadas a la API: 
{
  "service_key": "tu_service_key_aquí",
  // ... otros parámetros
}
Mantén tus claves de servicio seguras y nunca las expongas en código del lado del cliente ni en repositorios públicos

​
Parámetros comunes

La mayoría de los endpoints de la Analytics API admiten estos parámetros comunes:
ParámetroTipoObligatorioDescripción
service_keystringSíTu clave de servicio para la autenticación
group_namestringNoFiltra los resultados a un grupo específico
start_timestampstringVariableHora de inicio en formato RFC 3339 (p. ej., 2023-01-01T00:00:00Z)
end_timestampstringVariableHora de fin en formato RFC 3339 (p. ej., 2023-12-31T23:59:59Z)

​
Endpoints disponibles

La Analytics API proporciona tres endpoints principales:
  1. User Page Analytics - Obtén datos de actividad de usuarios desde la página de Teams
  2. Cascade Analytics - Consulta métricas de uso específicas de Cascade
  3. Custom Analytics - Consultas flexibles con selections, filtros y aggregations

​
Límites de solicitudes

Las solicitudes a la API están sujetas a limitación de tasa para garantizar la estabilidad del servicio. Si excedes el límite, recibirás una respuesta 429 Too Many Requests.

​
Soporte

Para soporte de la API y preguntas, ponte en contacto con Windsurf Support.