Endpoints
All endpoints are under the base path /api/v1/. Authentication is required for all endpoints (see Authentication).
Audiences
| Method | Path | Description |
|---|---|---|
GET | /audiences/ | List all audiences in your workspace. |
POST | /audiences/ | Create a new audience. |
GET | /audiences/{id}/ | Get an audience by ID. |
PATCH | /audiences/{id}/ | Update an audience (name, filters, status, etc.). |
DELETE | /audiences/{id}/ | Delete an audience and its remote lists on ad platforms. |
Audience Destinations
| Method | Path | Description |
|---|---|---|
GET | /audience-destinations/ | List all audience destinations. |
POST | /audience-destinations/ | Add a destination to an audience. |
GET | /audience-destinations/{id}/ | Get a destination by ID. |
PATCH | /audience-destinations/{id}/ | Update a destination configuration. |
DELETE | /audience-destinations/{id}/ | Remove a destination (also deletes the remote audience list). |
Signals
| Method | Path | Description |
|---|---|---|
GET | /signals/ | List all signals in your workspace. |
POST | /signals/ | Create a new signal. |
GET | /signals/{id}/ | Get a signal by ID. |
PATCH | /signals/{id}/ | Update a signal. |
DELETE | /signals/{id}/ | Delete a signal and stop all its scheduled runs. |
Signal Destinations
| Method | Path | Description |
|---|---|---|
GET | /signal-destinations/ | List all signal destinations. |
POST | /signal-destinations/ | Add a destination to a signal. |
GET | /signal-destinations/{id}/ | Get a signal destination by ID. |
PATCH | /signal-destinations/{id}/ | Update a signal destination configuration. |
DELETE | /signal-destinations/{id}/ | Remove a signal destination. |
Connections
| Method | Path | Description |
|---|---|---|
GET | /connections/ | List all connections in your workspace. |
POST | /connections/ | Create a new connection. |
GET | /connections/{id}/ | Get a connection by ID. |
PATCH | /connections/{id}/ | Update a connection (e.g., rename, update credentials). |
DELETE | /connections/{id}/ | Delete a connection. |
Connection Types
| Method | Path | Description |
|---|---|---|
GET | /connection-types/ | List all available connection types. |
GET | /connection-types/{id}/ | Get a connection type by ID. |
AI Models
Model Types (read-only)
| Method | Path | Description |
|---|---|---|
GET | /ai-model-types/ | List all available AI model types. |
GET | /ai-model-types/{id}/ | Get a model type by ID. |
Model Instances
| Method | Path | Description |
|---|---|---|
GET | /ai-model-instances/ | List all AI model instances in your workspace. |
POST | /ai-model-instances/ | Create a new AI model instance. |
GET | /ai-model-instances/{id}/ | Get a model instance by ID. |
PATCH | /ai-model-instances/{id}/ | Update a model instance (configuration, status, etc.). |
DELETE | /ai-model-instances/{id}/ | Delete a model instance and stop its scheduled runs. |
Authentication
| Method | Path | Description |
|---|---|---|
POST | /jwt/create/ | Obtain a JWT access + refresh token pair. |
POST | /jwt/refresh/ | Refresh an expired access token. |
POST | /jwt/verify/ | Check whether a token is valid. |
POST | /jwt/logout/ | Invalidate the refresh token. |
Users
| Method | Path | Description |
|---|---|---|
GET | /auth/users/ | List users in your workspace. |
GET | /auth/users/{id}/ | Get a user by ID. |
PATCH | /auth/users/{id}/ | Update a user profile. |
Dashboard
| Method | Path | Description |
|---|---|---|
GET | /dashboard/ | Get a summary of your workspace — counts and status breakdowns for connections, audiences, signals, and AI models. |
GET | /dashboard/last-activities/ | Get the recent sync activity feed for your workspace. |
Data Diagnosis
| Method | Path | Description |
|---|---|---|
GET | /data-diagnosis/ | Get data quality metrics for your connected data sources. |
Version
| Method | Path | Description |
|---|---|---|
GET | /version/ | Get the current platform version. |
GET | /versions/ | List all platform versions with release dates. |
GET | /changelog/ | List changelog entries by version and change type. |