Media providers#

Manage reusable providers for broadcast, outdoor, print, event, podcast, and PR activities.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/media-providers#

List providers that organized, published, sold, or delivered marketing activity, ordered by any column.

bash

GET /v1/media-providers?page_index=0&page_size=25&workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
pageIndex	`integer`	Required	Zero-based page index for pagination.
pageSize	`integer`	Required	Number of items per page (1-100).
workspaceId	`string (UUID)`	Required	Workspace identifier.
searchTerm	`string`	—	Free-text search term to filter results (max 200 characters).
sortBy	`'name' \| 'websiteUrl' \| 'createdAt' \| 'activityCount' \| 'spend' \| 'impressions'`	—	Media provider field to sort by.
sortDirection	`'asc' \| 'desc'`	—	Sort direction: ascending or descending.
dateFrom	`string`	—	Earliest date to include, as YYYY-MM-DD in the workspace timezone.
dateTo	`string`	—	Latest date to include, as YYYY-MM-DD in the workspace timezone. Use the same date as dateFrom for a single day.

Response#

Returns { items, totalCount, facets, _meta } with paginated results.

POST /v1/media-providers#

Create a reusable media provider with an optional website and private notes for provider-delivered activities.

bash

POST /v1/media-providers
Authorization: Bearer {token}
Content-Type: application/json

{
  "workspace_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "name": "My Campaign"
}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Unique identifier (UUID v4).
name	`string`	Required	Media provider name.
websiteUrl	`string (URL) \| null`	—	Public website URL for the media provider.
notes	`string \| null`	—	Private notes about the media provider.

Response#

Returns { data, _meta } with the result.

GET /v1/media-providers/stats#

Get spend, delivery coverage, weighted CPM, and attention statistics for media providers.

bash

GET /v1/media-providers/stats?workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Workspace identifier.
searchTerm	`string`	—	Free-text search term to filter results (max 200 characters).
dateFrom	`string`	—	Earliest date to include, as YYYY-MM-DD in the workspace timezone.
dateTo	`string`	—	Latest date to include, as YYYY-MM-DD in the workspace timezone. Use the same date as dateFrom for a single day.

Response#

Returns { data, _meta } with the result.

PATCH /v1/media-providers/:id#

Update a media provider name, website, or private notes.

bash

PATCH /v1/media-providers/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Unique identifier (UUID v4).
name	`string`	—	Updated display name (1-255 characters).
websiteUrl	`string (URL) \| null`	—	Updated public website URL for the media provider.
notes	`string \| null`	—	Updated private notes about the media provider.

Response#

Returns { data, _meta } with the result.

DELETE /v1/media-providers/:id#

Delete a media provider that has no active delivered activities linked to it.

bash

DELETE /v1/media-providers/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Unique identifier (UUID v4).

Response#

Returns { data, _meta } with the result.

GET /v1/media-providers/:id#

Get a media provider with delivered activity, spend, and impression totals.

bash

GET /v1/media-providers/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Media provider identifier.

Response#

Returns { data, _meta } with the result.