​
Overview

The Windsurf Analytics API enables enterprise customers to programmatically access detailed usage analytics for their teams. Query data from autocomplete, chat, command features, and Cascade with flexible filtering, grouping, and aggregation options.
The Analytics API is available for Enterprise plans only
API data is refreshed every 3 hours

​
Base URL

All API requests should be made to: 
https://server.codeium.com/api/v1/

​
Authentication

The Analytics API uses service keys for authentication. Service keys must be included in the request body of all API calls.

​
Creating a Service Key

  1. Navigate to your team settings page
  2. Go to the “Service Keys” section
  3. Create a new service key with appropriate permissions
  4. Copy the generated service key for use in API requests

​
Required Permissions

All Analytics API endpoints require “Teams Read-only” permissions.

​
Using Service Keys

Include your service key in the request body of all API calls: 
{
  "service_key": "your_service_key_here",
  // ... other parameters
}
Keep your service keys secure and never expose them in client-side code or public repositories

​
Common Parameters

Most Analytics API endpoints support these common parameters:
ParameterTypeRequiredDescription
service_keystringYesYour service key for authentication
group_namestringNoFilter results to a specific group
start_timestampstringVariesStart time in RFC 3339 format (e.g., 2023-01-01T00:00:00Z)
end_timestampstringVariesEnd time in RFC 3339 format (e.g., 2023-12-31T23:59:59Z)

​
Available Endpoints

The Analytics API provides three main endpoints:
  1. User Page Analytics - Get user activity data from the teams page
  2. Cascade Analytics - Query Cascade-specific usage metrics
  3. Custom Analytics - Flexible querying with custom selections, filters, and aggregations

​
Rate Limits

API requests are subject to rate limiting to ensure service stability. If you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

​
Support

For API support and questions, please contact Windsurf Support.