Campaign metrics overview

GET

campaigns

{campaignId}

metrics

overview

Campaign metrics overview

curl --request GET \
  --url https://api.getsoundlink.com/v1/campaigns/{campaignId}/metrics/overview \
  --header 'x-api-key: <api-key>'

{
  "data": {
    "listeners": 4821,
    "streams": 9340,
    "followers": 312,
    "impressions": 48210,
    "ad_clicks": 1120,
    "link_clicks": 890,
    "spend_media": 134.5,
    "spend_total": 168.13,
    "fees": 33.63,
    "currency": "USD",
    "cpl": 0.028,
    "cpf": 0.43,
    "streams_per_listener": 1.94
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

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) enforced by the backend.

Path Parameters

campaignId

string

required

Campaign identifier (e.g. camp_abc123)

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.

Show child attributes

meta

object

required

Show child attributes

Campaign metrics breakdownPer-day metrics broken down by country. One row per `(report_date, campaign_id, country_code)`. Can be large, so results are paginated. **Row schema:** `campaign_country_daily` v1.0 — the same schema used in JSONL bulk exports. Rows are idempotent on the primary key `(provider, account_id, report_date, campaign_id, country_code)`; re-ingesting is safe. **Mutability window:** rows for a given `report_date` can be revised for up to 7 days after the date closes due to delayed events from Meta and Spotify. Re-fetch or re-ingest accordingly. Maps to the **Countries** tab in the Soundlink Insights UI. Use for daily warehouse loads.

Campaign metrics overview

curl --request GET \
  --url https://api.getsoundlink.com/v1/campaigns/{campaignId}/metrics/overview \
  --header 'x-api-key: <api-key>'

{
  "data": {
    "listeners": 4821,
    "streams": 9340,
    "followers": 312,
    "impressions": 48210,
    "ad_clicks": 1120,
    "link_clicks": 890,
    "spend_media": 134.5,
    "spend_total": 168.13,
    "fees": 33.63,
    "currency": "USD",
    "cpl": 0.028,
    "cpf": 0.43,
    "streams_per_listener": 1.94
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}