Skip to main content
GET
Campaign metrics overview

Authorizations

x-api-key
string
header
required

Pass your Soundlink sk_* API key in the x-api-key header. Keys can carry explicit scopes (for example campaigns:read, metrics:read, videos:write) enforced by the backend.

Deprecated, retiring 2026-08-17 — migrate to Authorization: Bearer sk_... (see apiKeyBearerAuth) before then.

Path Parameters

campaignId
string
required

Campaign identifier (UUID)

Query Parameters

startDate
string<date>

Inclusive start date (YYYY-MM-DD). Defaults to campaign start date.

endDate
string<date>

Inclusive end date (YYYY-MM-DD). Defaults to today.

Response

Campaign totals

data
object
required

Campaign-level totals aggregated across all countries for the requested date range. Field names align with the campaign_country_daily row schema — values here are the sum of country rows.

meta
object
required