​
Visão geral

A Analytics API do Windsurf permite que clientes Enterprise acessem programaticamente análises detalhadas de uso de suas equipes. Consulte dados de Autocomplete, Chat, Command e Cascade com opções flexíveis de filtragem, agrupamento e agregação.
A Analytics API está disponível somente para planos Enterprise
Os dados da API são atualizados a cada 3 horas

​
URL base

Todas as requisições à API devem ser feitas para: 
https://server.codeium.com/api/v1/

​
Autenticação

A Analytics API usa Service Keys para autenticação. As Service Keys devem ser incluídas no corpo da requisição de todas as chamadas de API.

​
Criando uma Chave de serviço

  1. Acesse a página de configurações da equipe
  2. Vá até a seção “Chaves de serviço”
  3. Crie uma nova Chave de serviço com as permissões adequadas
  4. Copie a Chave de serviço gerada para usar em solicitações à API

​
Permissões necessárias

Todos os endpoints da Analytics API exigem a permissão “Teams somente leitura”.

​
Usando Chaves de serviço

Inclua sua Service Key no corpo da solicitação de todas as chamadas à API: 
{
  "service_key": "sua_service_key_aqui",
  // ... outros parâmetros
}
Mantenha suas Service Keys seguras e nunca as exponha em código cliente ou em repositórios públicos

​
Parâmetros comuns

A maioria dos endpoints da Analytics API oferece suporte a estes parâmetros comuns:
ParâmetroTipoObrigatórioDescrição
service_keystringSimSua Service Key para autenticação
group_namestringNãoFiltra os resultados para um grupo específico
start_timestampstringVariaHorário de início no formato RFC 3339 (por exemplo, 2023-01-01T00:00:00Z)
end_timestampstringVariaHorário de término no formato RFC 3339 (por exemplo, 2023-12-31T23:59:59Z)

​
Endpoints disponíveis

A Analytics API fornece três endpoints principais:
  1. User Page Analytics - Obtenha dados de atividade do usuário na página de Teams
  2. Cascade Analytics - Consulte métricas de uso específicas do Cascade
  3. Custom Analytics - Consulta flexível com selections, filtros e aggregations

​
Limites de taxa

As requisições à API estão sujeitas a rate limiting para garantir a estabilidade do serviço. Se você exceder o limite, receberá uma resposta 429 Too Many Requests.

​
Suporte

Para suporte e dúvidas sobre a API, entre em contato com o suporte da Windsurf.