Windsor.ai Connectors API Documentation

https://windsor.ai/api-documentation
Admin
Windsor.ai Connectors provide a unified API to access data from over 300 marketing, analytics, and...
Tokens:8,668
Snippets:83
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### API Key Authentication Example

Source: https://windsor.ai/api-documentation

Include your API key in all requests using the `api_key` parameter. This example shows the basic structure with authentication.

```url
https://connectors.windsor.ai/{connector}?api_key=your_api_key_here&fields=date,spend
```

--------------------------------

### Example Connector Options Response

Source: https://windsor.ai/api-documentation

A simplified example of the JSON response when requesting connector options. It details fields, their types, and possible values.

```JSON
{ "fields": [ { "key": "account_id", "label": "Ad Account", "type": "dropdown", "required": true, "values": [ { "id": "1234567890", "name": "ACME Ads Account" }, { "id": "9876543210", "name": "Europe Ads Account" } ] }, { "key": "breakdowns", "label": "Breakdowns", "type": "multi_select", "required": false, "values": [ "age", "gender", "country", "placement" ] }, { "key": "level", "label": "Reporting Level", "type": "select", "required": false, "values": [ "ad", "adset", "campaign", "account" ] } ] }
```

--------------------------------

### Example Request with Refresh Parameters

Source: https://windsor.ai/api-documentation

This example demonstrates how to use the `refresh_since` and `refresh_interval` parameters to control the refresh rate of recent data for a specific connector.

```APIDOC
## GET https://connectors.windsor.ai/google_ads

### Description
Retrieves Google Ads data, refreshing the last 3 days of data at least once per hour.

### Method
GET

### Endpoint
https://connectors.windsor.ai/google_ads

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Windsor.ai API key.
- **fields** (string) - Required - Comma-separated list of fields to retrieve (e.g., "date,campaign,spend").
- **refresh_since** (string) - Optional - Defines the recent time window for re-fetching data (default is "3d").
- **refresh_interval** (string) - Optional - Defines how often data in the `refresh_since` window should be refreshed (e.g., "1h").

### Request Example
```json
{
  "example": "https://connectors.windsor.ai/google_ads?api_key=API_KEY&fields=date,campaign,spend&refresh_since=3d&refresh_interval=1h"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of objects containing Google Ads performance data.

#### Response Example
```json
{
  "example": [
    {
      "date": "2023-10-26",
      "campaign": "Fall Campaign",
      "spend": 200.50
    }
  ]
}
```
```

--------------------------------

### Comparing Multiple Platforms

Source: https://windsor.ai/api-documentation

Example of comparing performance data across multiple platforms.

```APIDOC
## GET /all

### Description
Retrieves and compares performance data from multiple platforms for the last 30 days.

### Method
GET

### Endpoint
https://connectors.windsor.ai/all

### Query Parameters
- **fields** (string) - Required - Comma-separated list of fields to retrieve (e.g., date,source,spend,impressions,clicks).
- **date_preset** (string) - Required - Preset for the date range (e.g., last_30d).
- **api_key** (string) - Required - Your Windsor.ai API key.
```

--------------------------------

### Compare Multiple Platforms

Source: https://windsor.ai/api-documentation

Example for comparing performance across multiple platforms. It fetches common metrics like date, source, spend, and impressions for the last 30 days.

```HTTP
https://connectors.windsor.ai/all?fields=date,source,spend,impressions,clicks&date_preset=last_30d&api_key={your_api_key}
```

--------------------------------

### Get Connector Options

Source: https://windsor.ai/api-documentation

Retrieve all available configuration options for a specific connector. This is useful for customizing data pulls and validating user input.

```HTTP
https://connectors.windsor.ai/{connector}/options
```

```HTTP
https://connectors.windsor.ai/facebook/options
```

--------------------------------

### Get E-commerce Conversion Data

Source: https://windsor.ai/api-documentation

Example for retrieving e-commerce conversion data from Google Analytics 4. It includes fields like date, campaign, transactions, and revenue for the last 30 days.

```HTTP
https://connectors.windsor.ai/googleanalytics4?fields=date,campaign,transactions,revenue&date_preset=last_30d&api_key={your_api_key}
```

--------------------------------

### Get Options for a Specific Connector

Source: https://windsor.ai/api-documentation

Retrieve all available configuration options for a specific connector. These options allow customization of data retrieval, such as selecting accounts or toggling breakdowns.

```APIDOC
## Get Options for a Specific Connector

### Description
Retrieve all available configuration options for a specific connector, allowing customization of data pulling.

### Method
GET

### Endpoint
https://connectors.windsor.ai/{connector}/options

### Parameters
#### Path Parameters
- **connector** (string) - Required - The connector ID (e.g., facebook, hubspot, salesforce).

### Response
#### Success Response (200)
- **fields** (array) - An array of option objects, each with `key`, `label`, `type`, `required`, and `values`.
```

--------------------------------

### Facebook Campaign Performance

Source: https://windsor.ai/api-documentation

Example of retrieving campaign performance data from Facebook.

```APIDOC
## GET /facebook

### Description
Retrieves campaign performance data from Facebook for the last 30 days.

### Method
GET

### Endpoint
https://connectors.windsor.ai/facebook

### Query Parameters
- **fields** (string) - Required - Comma-separated list of fields to retrieve (e.g., date,campaign,spend,impressions,clicks).
- **date_preset** (string) - Required - Preset for the date range (e.g., last_30d).
- **api_key** (string) - Required - Your Windsor.ai API key.
```

--------------------------------

### Retrieve Fields for a Specific Connector

Source: https://windsor.ai/api-documentation

Get a list of all available fields for a given connector. Include your API key to also retrieve custom fields configured for your account.

```HTTP
https://connectors.windsor.ai/{connector}/fields
```

```HTTP
https://connectors.windsor.ai/facebook/fields?api_key={your_api_key}
```

--------------------------------

### Retrieve Available Fields for a Connector

Source: https://windsor.ai/api-documentation

Get a list of all available fields for a specific connector, including custom fields if authenticated. This helps in understanding the data structure for API queries.

```APIDOC
## Retrieve Available Fields for a Connector

### Description
Retrieve a list of all available fields for a specific connector. This endpoint can also return custom fields if authenticated with an API key.

### Method
GET

### Endpoint
https://connectors.windsor.ai/{connector}/fields

### Parameters
#### Query Parameters
- **api_key** (string) - Optional - Your API key for authentication and retrieving custom fields.

### Response
#### Success Response (200)
- **fields** (array) - An array of field objects, each containing `Field ID`, `Field name`, `Field type`, and `Field description`.
```

--------------------------------

### Refresh Google Ads Data Hourly

Source: https://windsor.ai/api-documentation

Example demonstrating how to refresh the last 3 days of Google Ads data at least once per hour using `refresh_since` and `refresh_interval` parameters.

```url
https://connectors.windsor.ai/google_ads?api_key=API_KEY&fields=date,campaign,spend&refresh_since=3d&refresh_interval=1h
```

--------------------------------

### Google Analytics 4 Conversion Data

Source: https://windsor.ai/api-documentation

Example of retrieving e-commerce conversion data from Google Analytics 4.

```APIDOC
## GET /googleanalytics4

### Description
Retrieves e-commerce conversion data from Google Analytics 4 for the last 30 days.

### Method
GET

### Endpoint
https://connectors.windsor.ai/googleanalytics4

### Query Parameters
- **fields** (string) - Required - Comma-separated list of fields to retrieve (e.g., date,campaign,transactions,revenue).
- **date_preset** (string) - Required - Preset for the date range (e.g., last_30d).
- **api_key** (string) - Required - Your Windsor.ai API key.
```

--------------------------------

### Retrieve Campaign Performance

Source: https://windsor.ai/api-documentation

Example of retrieving campaign performance data from Facebook. It specifies fields like date, campaign, spend, and impressions for the last 30 days.

```HTTP
https://connectors.windsor.ai/facebook?fields=date,campaign,spend,impressions,clicks&date_preset=last_30d&api_key={your_api_key}
```

--------------------------------

### Filter Data for Null Values

Source: https://windsor.ai/api-documentation

Check for fields that contain null values, for example, to find records without click data. URL-encode the filter parameter for actual API calls.

```url
https://connectors.windsor.ai/facebook?fields=date,campaign,clicks&filter=[["clicks","null",null]]&api_key={your_api_key}
```

--------------------------------

### Fetch Data with Python

Source: https://windsor.ai/api-documentation

Use the requests library to fetch data from the API. Ensure you replace 'your_api_key_here' with your actual API key.

```python
import requests

API_KEY = "your_api_key_here"
connector = "facebook"
fields = "date,campaign,spend,impressions,clicks"

url = f"https://connectors.windsor.ai/{connector}?api_key={API_KEY}&fields={fields}"

response = requests.get(url)
print(response.json())
```

--------------------------------

### Fetch Data with Javascript

Source: https://windsor.ai/api-documentation

Use the fetch API to retrieve data from the Windsor.ai API. Replace 'your_api_key_here' with your valid API key.

```javascript
const API_KEY = "your_api_key_here";
const connector = "facebook";
const fields = "date,campaign,spend,impressions,clicks";

const url = `https://connectors.windsor.ai/${connector}?api_key=${API_KEY}&fields=${fields}`;

fetch(url)
.then(res => res.json())
.then(data => console.log(data))
.catch(err => console.error("API error:", err));
```

--------------------------------

### List All Connectors

Source: https://windsor.ai/api-documentation

Retrieve a list of all connectors available through the Windsor.ai API. This is useful for understanding the full range of data sources you can integrate with.

```APIDOC
## List All Connectors

### Description
Get a list of all available connectors through the Windsor.ai API.

### Method
GET

### Endpoint
https://connectors.windsor.ai/list_connectors

### Response
#### Success Response (200)
- **connectors** (array) - A JSON array of all available connector objects.
```

--------------------------------

### List Available Connectors

Source: https://windsor.ai/api-documentation

Retrieve a list of all connectors available through the Windsor.ai API. This endpoint returns a JSON array.

```HTTP
https://connectors.windsor.ai/list_connectors
```

--------------------------------

### List Connected Accounts for All Data Sources

Source: https://windsor.ai/api-documentation

Returns all data source accounts connected to your Windsor.ai workspace, for all data sources.

```APIDOC
## List accounts for all data sources

Endpoint:
```
https://onboard.windsor.ai/api/common/ds-accounts?datasource=all
```

**Example response (simplified):**
```
[ { "datasource": "google_ads", "account_name": "ACME Google Ads", "account_id": "123-456-7890", "status": "active" }, { "datasource": "facebook", "account_name": "ACME Facebook Ads", "account_id": "987654321", "status": "active" } ]
```
```

--------------------------------

### Date Filtering with Presets

Source: https://windsor.ai/api-documentation

Demonstrates how to filter data by date using predefined presets like 'last_30d'. This is a convenient way to fetch data for common recent periods.

```APIDOC
## Date Filtering with Presets

### Description
Filters data by specifying a date range using a predefined preset.

### Method
GET

### Endpoint
`https://connectors.windsor.ai/{connector}`

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Windsor.ai API key.
- **connector** (string) - Required - The name of the data connector.
- **fields** (string) - Required - A comma-separated list of fields to retrieve.
- **date_preset** (string) - Required - A predefined date range (e.g., 'last_30d', 'last_7d', 'last_90d', 'last_year').

### Request Example
```
https://connectors.windsor.ai/facebook?fields=date,spend&date_preset=last_30d
```

### Response
#### Success Response (200)
Returns a JSON object containing data for the specified date preset.
```

--------------------------------

### List All Connected Data Source Accounts

Source: https://windsor.ai/api-documentation

Retrieve a list of all data source accounts connected to your Windsor.ai workspace. This provides an overview of all integrated sources.

```URL
https://onboard.windsor.ai/api/common/ds-accounts?datasource=all
```

--------------------------------

### Generate Authorization Link for Any Data Source

Source: https://windsor.ai/api-documentation

Generate a co-user authorization link that allows users to connect any data source supported by Windsor.ai. The user will be able to choose from available connectors.

```URL
https://onboard.windsor.ai/api/team/generate-co-user-url?api_key={API_KEY}
```

```URL
https://onboard.windsor.ai/api/team/generate-co-user-url?api_key=YOUR_API_KEY
```

--------------------------------

### Basic API Request Structure

Source: https://windsor.ai/api-documentation

This is the fundamental structure for making requests to the Windsor.ai Connectors API. It includes the base URL, the specific connector, the fields you wish to retrieve, and your API key.

```APIDOC
## GET https://connectors.windsor.ai/{connector}

### Description
Retrieves data from a specified connector.

### Method
GET

### Endpoint
https://connectors.windsor.ai/{connector}

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Windsor.ai API key.
- **fields** (string) - Required - Comma-separated list of fields to retrieve (e.g., "date,spend").
- **date_preset** (string) - Optional - Predefined date range (e.g., "last_7d", "last_30d").
- **date_from** (string) - Optional - Start date in YYYY-MM-DD format.
- **date_to** (string) - Optional - End date in YYYY-MM-DD format.
- **_max_rows** (integer) - Optional - Maximum number of records to return.
- **filter** (string) - Optional - Filter expression (e.g., "[["campaign","eq","search_competitors_tier1"]]" ).
- **refresh_since** (string) - Optional - Defines the recent time window for re-fetching data (e.g., "3d").
- **refresh_interval** (string) - Optional - Defines how often data in the `refresh_since` window should be refreshed (e.g., "1h", "15min").

### Request Example
```json
{
  "example": "https://connectors.windsor.ai/google_ads?api_key=YOUR_API_KEY&fields=date,campaign,spend&date_preset=last_7d"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of objects, where each object represents a record with the requested fields.

#### Response Example
```json
{
  "example": [
    {
      "date": "2023-10-26",
      "campaign": "Summer Sale 2023",
      "spend": 150.75
    }
  ]
}
```
```

--------------------------------

### List Connected Accounts for a Specific Data Source

Source: https://windsor.ai/api-documentation

Returns data source accounts connected to your Windsor.ai workspace for a specific data source.

```APIDOC
## List accounts for a specific data source

Endpoint:
```
https://onboard.windsor.ai/api/common/ds-accounts?datasource={SOURCE}
```

**Example (Facebook Ads data source):**
```
https://onboard.windsor.ai/api/common/ds-accounts?datasource=facebook
```

Returns only Facebook Ads accounts connected to the workspace.
```

--------------------------------

### Basic Data Retrieval

Source: https://windsor.ai/api-documentation

This snippet shows how to retrieve basic data fields for a specified connector using an API key. It demonstrates the fundamental structure for making API calls.

```APIDOC
## Basic Data Retrieval

### Description
Retrieves specified fields from a given connector using an API key.

### Method
GET

### Endpoint
`https://connectors.windsor.ai/{connector}`

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Windsor.ai API key.
- **connector** (string) - Required - The name of the data connector (e.g., 'facebook').
- **fields** (string) - Required - A comma-separated list of fields to retrieve (e.g., 'date,campaign,spend').

### Request Example
```
https://connectors.windsor.ai/facebook?api_key=your_api_key_here&fields=date,campaign,spend,impressions,clicks
```

### Response
#### Success Response (200)
Returns a JSON object containing the requested data fields.
```

--------------------------------

### Generate Authorization Link for Any Data Source

Source: https://windsor.ai/api-documentation

Generates a co-user authorization link that allows the user to connect any data source supported by Windsor.ai.

```APIDOC
## Authorization link for any data source

Use this endpoint if you want the user to connect any data source supported by Windsor.ai:
```
https://onboard.windsor.ai/api/team/generate-co-user-url?api_key={API_KEY}
```

**Example:**
```
https://onboard.windsor.ai/api/team/generate-co-user-url?api_key=YOUR_API_KEY
```

This link lets the user choose and authorize any available connector.
```

--------------------------------

### List all custom fields

Source: https://windsor.ai/api-documentation

Retrieves a list of all custom fields that are available immediately after creation and can be referenced in API queries.

```APIDOC
## GET /api/custom-fields

### Description
Retrieves a list of all custom fields available for use in API queries.

### Method
GET

### Endpoint
https://onboard.windsor.ai/api/custom-fields

### Response
#### Success Response (200)
- **fields** (array) - A list of custom fields.
```

--------------------------------

### Basic API Request Structure

Source: https://windsor.ai/api-documentation

A fundamental API request structure including the connector, fields, and API key.

```url
https://connectors.windsor.ai/{connector}?fields={field1,field2,...}&api_key={your_api_key}
```

--------------------------------

### Base URL for API Requests

Source: https://windsor.ai/api-documentation

The base URL for all API requests to the Windsor.ai Connectors API.

```url
https://connectors.windsor.ai
```

--------------------------------

### Windsor.ai API Data Renderers

Source: https://windsor.ai/api-documentation

Specify the desired data format for API responses. Options include JSON, CSV, and direct import to Google Sheets. JSON is the default if no renderer is specified.

```URL
https://connectors.windsor.ai/googleanalytics4?api_key=your_api_key&fields=date,spend&_renderer=json
```

```URL
https://connectors.windsor.ai/googleanalytics4?api_key=your_api_key&fields=date,spend&_renderer=csv
```

```URL
https://connectors.windsor.ai/googleanalytics4?api_key=your_api_key&fields=date,spend&_renderer=googlesheets
```

--------------------------------

### Filter Data by Date Preset

Source: https://windsor.ai/api-documentation

Specify a date range using the 'date_preset' parameter for common intervals like the last 30 days.

```url
https://connectors.windsor.ai/facebook?fields=date,spend&date_preset=last_30d
```

--------------------------------

### List Custom Fields Endpoint

Source: https://windsor.ai/api-documentation

This endpoint provides a list of custom fields available immediately after creation. These fields can be referenced in API queries.

```HTTP
https://onboard.windsor.ai/api/custom-fields
```

--------------------------------

### Fetch Data with Filters in Javascript

Source: https://windsor.ai/api-documentation

Use Javascript's fetch API to retrieve data with filters. The filter array needs to be stringified using JSON.stringify.

```javascript
const apiKey = "your_api_key_here";
const connector = "facebook";
const fields = "date,campaign,spend";

// Convert the filter array to JSON string
const filterQuery = JSON.stringify([["spend","gt",100],"and",["campaign","contains","Sale"]]);

const url = `https://connectors.windsor.ai/${connector}?api_key=${apiKey}&fields=${fields}&filter=${filterQuery}`;

fetch(url)
.then(res => res.json())
.then(data => console.log(data))
.catch(err => console.error("API error:", err));
```

--------------------------------

### List Connected Accounts for a Specific Data Source

Source: https://windsor.ai/api-documentation

Fetch connected accounts for a single, specified data source, such as Facebook Ads. This allows for targeted retrieval of account information.

```URL
https://onboard.windsor.ai/api/common/ds-accounts?datasource={SOURCE}
```

```URL
https://onboard.windsor.ai/api/common/ds-accounts?datasource=facebook
```

--------------------------------

### Windsor.ai API User Agent

Source: https://windsor.ai/api-documentation

The user agent string used by Windsor.ai connectors. It is recommended to include this in custom integrations for better tracking and support.

```Text
Windsor/1.0
```

--------------------------------

### Date Filtering with Custom Dates

Source: https://windsor.ai/api-documentation

Shows how to filter data by specifying a custom date range using 'date_from' and 'date_to' parameters. The 'date_to' parameter defaults to the current date if not provided.

```APIDOC
## Date Filtering with Custom Dates

### Description
Filters data by specifying a custom date range using 'date_from' and 'date_to' parameters.

### Method
GET

### Endpoint
`https://connectors.windsor.ai/{connector}`

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Windsor.ai API key.
- **connector** (string) - Required - The name of the data connector.
- **fields** (string) - Required - A comma-separated list of fields to retrieve.
- **date_from** (string) - Required - The start date of the range (YYYY-MM-DD).
- **date_to** (string) - Optional - The end date of the range (YYYY-MM-DD). Defaults to the current date.

### Request Example
```
https://connectors.windsor.ai/facebook?fields=date,spend&date_from=2023-01-01&date_to=2023-01-31&api_key=your_api_key_here
```

### Response
#### Success Response (200)
Returns a JSON object containing data within the specified custom date range.
```

--------------------------------

### Generate Authorization Link for Single Data Source

Source: https://windsor.ai/api-documentation

Create a co-user authorization link for a specific data source, such as LinkedIn Ads. This allows users to connect only the specified source without sharing credentials.

```URL
https://onboard.windsor.ai/api/team/generate-co-user-url/?allowed_sources={source}&api_key={API_KEY}
```

```URL
https://onboard.windsor.ai/api/team/generate-co-user-url/?allowed_sources=linkedin&api_key=YOUR_API_KEY
```

--------------------------------

### Fetch Data with Filters in Python

Source: https://windsor.ai/api-documentation

Use Python's requests library to fetch data with complex filters. The filter array must be converted to a JSON string using json.dumps.

```python
import requests
import json

api_key = "your_api_key_here"
connector = "facebook"
fields = "date,campaign,spend"

# Use json.dumps to convert the filter array to JSON string
filter_query = json.dumps([["spend","gt",100],"and",["campaign","contains","Sale"]])

url = f"https://connectors.windsor.ai/{connector}?api_key={api_key}&fields={fields}&filter={filter_query}"
response = requests.get(url)
print(response.json())
```

--------------------------------

### Renderers

Source: https://windsor.ai/api-documentation

Specifies the format of the data returned by the Windsor.ai API. Options include JSON, CSV, and Google Sheets.

```APIDOC
## Renderers

The `_renderer` parameter specifies the format of the data returned by the Windsor.ai API. Available options include:
  * **JSON** : returns data in JSON format, ideal for web applications and integrations.
```
https://connectors.windsor.ai/googleanalytics4?api_key=your_api_key&fields=date,spend&_renderer=json
```

  * **CSV** : returns data in CSV format, suitable for spreadsheets and data analysis.
```
https://connectors.windsor.ai/googleanalytics4?api_key=your_api_key&fields=date,spend&_renderer=csv
```

  * **Google Sheets** : directly imports data into Google Sheets.
```
https://connectors.windsor.ai/googleanalytics4?api_key=your_api_key&fields=date,spend&_renderer=googlesheets
```

**Default:** If no `_renderer` is specified, the API returns JSON format by default.
```

--------------------------------

### Standard API Response Format

Source: https://windsor.ai/api-documentation

The typical JSON structure for successful API responses, containing a 'data' array with the requested information.

```JSON
{
  "data": [
    {
      "date": "2023-01-01",
      "spend": 125.45,
      "impressions": 10234,
      "clicks": 342
    },
    {
      "date": "2023-01-02",
      "spend": 134.67,
      "impressions": 11456,
      "clicks": 389
    }
  ]
}
```

--------------------------------

### Generate Authorization Link for Single Data Source

Source: https://windsor.ai/api-documentation

Generates a co-user authorization link for a single, specific data source, allowing clients or teammates to connect their data without sharing credentials.

```APIDOC
## Generate authorization link for a single data source

Use this endpoint if you want the user to authorize only one specific data source.
```
https://onboard.windsor.ai/api/team/generate-co-user-url/?allowed_sources={source}&api_key={API_KEY}
```

**Example (LinkedIn Ads only):**
```
https://onboard.windsor.ai/api/team/generate-co-user-url/?allowed_sources=linkedin&api_key=YOUR_API_KEY
```

This link allows the user to connect only the LinkedIn data source.
```

--------------------------------

### Filter Data by Custom Date Range

Source: https://windsor.ai/api-documentation

Define a specific date range using 'date_from' and 'date_to' parameters. If 'date_to' is omitted, it defaults to the current date.

```url
https://connectors.windsor.ai/facebook?fields=date,spend&date_from=2023-01-01&date_to=2023-01-31&api_key={your_api_key}
```

--------------------------------

### Data Filtering with JSON Array

Source: https://windsor.ai/api-documentation

Explains how to filter data using complex conditions specified in a JSON array format. This allows for equality checks, comparisons, substring matching, and null checks, with support for AND/OR logic and nested conditions.

```APIDOC
## Data Filtering with JSON Array

### Description
Filters data based on complex conditions defined in a JSON array. Supports various operators and logical combinations (AND/OR).

### Method
GET

### Endpoint
`https://connectors.windsor.ai/{connector}`

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Windsor.ai API key.
- **connector** (string) - Required - The name of the data connector.
- **fields** (string) - Required - A comma-separated list of fields to retrieve.
- **filter** (string) - Required - A URL-encoded JSON string representing the filter conditions. Each condition is a list: `[field, operator, value]`. Conditions can be combined with 'and'/'or' and nested.

#### Supported Operators
- **eq**: Equals
- **neq**: Not equals
- **gt**: Greater than
- **gte**: Greater or equal
- **lt**: Less than
- **lte**: Less or equal
- **contains**: Contains substring
- **ncontains**: Does not contain substring
- **null**: Field is null
- **notnull**: Field is not null

### Request Example (Single Filter)
```
https://connectors.windsor.ai/facebook?fields=date,campaign,spend&filter=[["campaign","eq","Summer Sale"]]
```

### Request Example (Multiple Conditions - AND)
```
https://connectors.windsor.ai/facebook?fields=date,spend&filter=[["spend","gt",100],"and",["campaign","contains","Sale"]]
```

### Request Example (Nested Groups - AND + OR)
```
https://connectors.windsor.ai/facebook?fields=date,campaign,spend&filter=[[["campaign","eq","foobar"],"or",["spend","eq",10]],"and",["campaign","eq","abc (us)"]]
```

### Response
#### Success Response (200)
Returns a JSON object containing data that matches the specified filter conditions.
```

--------------------------------

### Filter Data with Nested Groups (AND + OR)

Source: https://windsor.ai/api-documentation

Create complex filtering logic with nested groups using 'and' and 'or' operators for advanced data selection. URL-encode the filter parameter for actual API calls.

```url
https://connectors.windsor.ai/facebook?fields=date,campaign,spend&filter=[[["campaign","eq","foobar"],"or",["spend","eq",10]],"and",["campaign","eq","abc (us)"]]&api_key={your_api_key}
```

--------------------------------

### Filter Data with Multiple AND Conditions

Source: https://windsor.ai/api-documentation

Combine multiple filter conditions using 'and' to narrow down results, such as filtering by spend greater than 100 and campaign containing 'Sale'. URL-encode the filter parameter for actual API calls.

```url
https://connectors.windsor.ai/facebook?fields=date,spend&filter=[["spend","gt",100],"and",["campaign","contains","Sale"]]&api_key={your_api_key}
```

--------------------------------

### List Co-user Linked Accounts

Source: https://windsor.ai/api-documentation

Retrieves a list of co-user linked accounts associated with your team. Can be filtered by data source ID or access token.

```APIDOC
## Co-user linked accounts

This endpoint allows you to retrieve a list of co-user linked accounts associated with your team.
**Endpoint URL:**
HTTP
```
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/
```

### Authentication
You can authenticate your request in two ways:
**1. API Key (Recommended for programmatic access):** Append your API key to the request using the api_key query parameter.
**2. Browser session:** The endpoint can be accessed without an API key if the user is actively logged into https://onboard.windsor.ai in the same browser session.
### Query parameters
**Parameter**| **Type**| **Required**| **Description**  
---|---|---|---
api_key| string| Yes*|  Your Windsor.ai API key _(Not required if making a request from an authenticated browser session)._  
ds_id| string| No|  Filter the results by a specific data source ID mysql, facebook_ads, etc.).  
access_token| string| No| Filter the results by a specific access token.  
### Important notes on the response
**access_token****vs****co_user_member_name** : The access_token value is only exposed for **newly created** authentication links. For existing/legacy auth links, the access_token will not be visible, and the co_user_member_name field will be shown instead.
### Example requests
**1. Basic request (All linked accounts)**
HTTP
```
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/?api_key=YOUR_API_KEY
```

**2. Filter by data source (****ds_id****)**
To retrieve only linked accounts for a specific data source, such as MySQL:
HTTP
```
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/?api_key=YOUR_API_KEY&ds_id=mysql
```

**3. Filter by access token (****access_token****)**
To retrieve details for a specific access token:
HTTP
```
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/?api_key=YOUR_API_KEY&access_token=YOUR_ACCESS_TOKEN
```
```

--------------------------------

### Retrieve Co-user Linked Accounts

Source: https://windsor.ai/api-documentation

Fetch a list of co-user linked accounts associated with your team. This endpoint can be filtered by data source ID or access token.

```HTTP
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/
```

```HTTP
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/?api_key=YOUR_API_KEY
```

```HTTP
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/?api_key=YOUR_API_KEY&ds_id=mysql
```

```HTTP
GET https://onboard.windsor.ai/api/team/co-user-linked-accounts/?api_key=YOUR_API_KEY&access_token=YOUR_ACCESS_TOKEN
```

--------------------------------

### API Error Response Format

Source: https://windsor.ai/api-documentation

The JSON structure returned when an API error occurs. It includes an error code and a descriptive message.

```JSON
{
  "error": {
    "code": "authentication_error",
    "message": "Invalid API key provided"
  }
}
```

--------------------------------

### Filter Data with Single Condition

Source: https://windsor.ai/api-documentation

Apply a single filter condition to the API request, such as filtering campaigns by name. URL-encode the filter parameter for actual API calls.

```url
https://connectors.windsor.ai/facebook?fields=date,campaign,spend&filter=[["campaign","eq","Summer Sale"]എന്നാൽ api_key={your_api_key}
```
Tokens:
Raw