---
title: "Windsurf"
canonical_url: "https://docs.getdx.com/connectors/windsurf/"
md_url: "https://docs.getdx.com/connectors/windsurf.md"
last_updated: "2026-06-18"
---

# Windsurf
By connecting Windsurf with DX, you can join Windsurf usage data with DX data to analyze usage and impact. Please refer to the API documentation below and our [schema explorer](https://docs.getdx.com/schema/) to see what data DX imports.

## Prerequisites

To connect Windsurf to DX, you need:

- a [Windsurf service key](https://docs.windsurf.com/plugins/accounts/analytics-api#user-data-analytics-api-specification)
- allowlist [DX IP addresses](https://docs.getdx.com/allowlisting-dx/) if your Windsurf instance is behind a firewall or has IP restrictions

## Setup instructions

Follow the steps below to connect Windsurf to DX.

#### Step 1

Create a Windsurf service key from the [Team settings](https://windsurf.com/team/settings) page. Please note that Windsurf service keys inherit the permissions of the admin user who generates the key—in order to access analytics APIs, the admin user must have the **Teams Read-only** and **Analytics Read** permission.

#### Step 2

Enable individual-level analytics for your Windsurf account by accessing the [Team management](https://windsurf.com/team/manage) page.

#### Step 3

- Navigate to the connections page in DX and select "+ Connection" in the top right.
- Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

## API reference

The table below lists the specific API endpoints that are used by DX.


| Endpoint | Documentation |
|----------------------------------|---------------|
| /api/v1/userPageAnalytics | [link](https://docs.windsurf.com/plugins/accounts/api-reference/user-page-analytics) |
| /api/v1/cascadeAnalytics | [link](https://docs.windsurf.com/windsurf/accounts/api-reference/cascade-analytics) |
| /api/v1/Analytics | [link](https://docs.windsurf.com/plugins/accounts/api-reference/custom-analytics) |


## Errors

The table below lists potential error codes when adding a connection in DX.


| Error | Description |
|----------------------|------------------------------------------------------------------------------------------------------------------|
| `invalid_credentials` | Your API credentials entered are not valid. |
| `invalid_configuration` | Your API token does not have the permissions required by DX. |
| `no_resources` | Your API token does not have access to any teams. |


## Troubleshooting

#### I'm seeing "invalid_configuration" error from API response

This most likely means that individual-level analytics are not enabled for your Windsurf account. To verify, use the curl below:

```
curl --location 'https://server.codeium.com/api/v1/CascadeAnalytics' \
--header 'Content-Type: application/json' \
--data-raw '{
  "service_key": "<YOUR-TOKEN>",
  "start_timestamp": "2024-01-01T00:00:00Z",
  "end_timestamp": "2025-06-10T00:00:00Z",
  "emails": ["your_email"],
  "query_requests": [
   {
    "cascade_lines": {}
   }
  ]
}
```

If you see the string "Enable individual level analytics" in response, then please refer to Step 2 of this guide to enable individual metrics.
---

## Sitemap

[Overview of all docs pages](/llms.txt)