Campaign metrics overview - Soundlink API

GET

/

v1

/

campaigns

/

{campaignId}

/

metrics

/

overview

Campaign metrics overview

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

import requests

url = "https://api.getsoundlink.com/v1/campaigns/{campaignId}/metrics/overview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getsoundlink.com/v1/campaigns/{campaignId}/metrics/overview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "listeners": 4821,
    "total_listeners": 5100,
    "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.83
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

Authorization

string

header

required

Pass your Soundlink sk_* API key as a Bearer token: Authorization: Bearer sk_<prefix>_<token> (not an OAuth token; see oauthBearer for that). Accepted on all Public API operations. Send only one Authorization header per request.

Path Parameters

campaignId

string

required

Campaign identifier (UUID)

Query Parameters

startDate

string<date>

Inclusive start date (YYYY-MM-DD). When omitted, the default depends on the endpoint: campaign overview and paginated breakdown use the campaign start date; engagement and JSONL export endpoints use the last 90 days ending today (see each operation).

endDate

string<date>

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

Response

Campaign totals

data

object

required

Campaign-level totals for the requested date range. Spend, streams, followers, delivery, and listeners come from summing campaign_country_daily rows. total_listeners is distinct listeners in the window (same definition as the dashboard), so it is not the sum of daily total_listeners from breakdown rows.

Show child attributes

meta

object

required

Show child attributes

Campaign metrics overview

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

import requests

url = "https://api.getsoundlink.com/v1/campaigns/{campaignId}/metrics/overview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getsoundlink.com/v1/campaigns/{campaignId}/metrics/overview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "listeners": 4821,
    "total_listeners": 5100,
    "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.83
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}