API Endpoints

This reference covers all available API endpoints organized by resource type. Each endpoint includes the HTTP method, path, parameters, and example responses.

Campaigns

GET    /v1/campaigns              — List all campaigns
GET    /v1/campaigns/:id          — Get a single campaign
POST   /v1/campaigns              — Create a new campaign
PATCH  /v1/campaigns/:id          — Update a campaign
DELETE /v1/campaigns/:id          — Archive a campaign
POST   /v1/campaigns/:id/launch   — Launch a draft campaign
POST   /v1/campaigns/:id/pause    — Pause an active campaign
POST   /v1/campaigns/:id/resume   — Resume a paused campaign

Creative

GET    /v1/creative               — List all creative assets
GET    /v1/creative/:id           — Get a single creative
POST   /v1/creative/generate      — Generate creative from a prompt
PATCH  /v1/creative/:id           — Update creative metadata
DELETE /v1/creative/:id           — Archive a creative asset
GET    /v1/creative/:id/variants  — List variants of a creative

Analytics

GET    /v1/analytics/overview     — Aggregate performance metrics
GET    /v1/analytics/campaigns    — Per-campaign metrics
GET    /v1/analytics/channels     — Per-channel metrics
GET    /v1/analytics/creative     — Per-creative metrics
GET    /v1/analytics/audiences    — Per-audience metrics
POST   /v1/analytics/query        — Custom metric query

Audiences

GET    /v1/audiences              — List all audiences
GET    /v1/audiences/:id          — Get a single audience
POST   /v1/audiences              — Create a new audience
PATCH  /v1/audiences/:id          — Update an audience
DELETE /v1/audiences/:id          — Archive an audience
GET    /v1/audiences/:id/insights — Get audience insights

Connections

GET    /v1/connections            — List all platform connections
GET    /v1/connections/:id        — Get connection details and status
DELETE /v1/connections/:id        — Disconnect a platform
POST   /v1/connections/:id/sync   — Trigger a manual sync

Query parameters

Most list endpoints support these common query parameters: 'limit' (default 20, max 100), 'cursor' (for pagination), 'sort' (field to sort by), 'order' (asc or desc), 'start_date' and 'end_date' (ISO 8601 format), and 'status' (filter by resource status).