By enabling the Windsurf connector allows you to import data on usage of Windsurf metrics at the user level. Please refer to the API documentation below for more details, and visit our schema explorer to see what data DX imports.

Prerequisites

To connect Windsurf to DX, you need:

Windsurf service key has implicit scopes based on the permissions of the admin user who generated it. To access analytics APIs, the admin user must have at least “Teams Read-only” access.

a Service key
if your Windsurf instance is behind a firewall or has IP restrictions, you need to allowlist DX IP addresses

Setup instructions

Step 1- Get Windsurf Service key

Navigate to Windsurf settings page and get your service key

Make sure to enable individual level analytics via https://windsurf.com/team/manage to query analytics for specific users

Step 2– Enable DX connector

Navigate to the connections page in DX and select "+ Connection" in the top right.
Enter the credentials you 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
POST /api/v1/UserPageAnalytics	User Page Analytics
POST /api/v1/CascadeAnalytics	User Analytics

Errors

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

Error	Description
`invalid_configuration`	Your API credentials entered are not having valid permissions.
`invalid_credentials`	Your API credentials entered are not valid.
`no_resources`	The provided credentials does not have access to any organizations or projects.