Metrics

Campaign creative metrics

Lifetime creative performance for one campaign, grouped by background video. Each group has a children array of variants. timestamp_start_ms and timestamp_end_ms are the audio cut in milliseconds when that cut is a ready sound for this organization. Otherwise both are null. Two cuts of the same track stay separate. This is a snapshot, not a date range. startDate and endDate are rejected.

Spend is omitted until media spend and fees can be split. Ratios use the same lifetime basis as the Creatives tab.

Requires the metrics:read scope. Accepts API key or OAuth Bearer.

GET

campaigns

{campaignId}

metrics

creatives

Campaign creative metrics

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

import requests

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

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/creatives', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "creatives": [
      {
        "video_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "caption": "Late night version",
        "listeners": 400,
        "followers": 80,
        "link_clicks": 280,
        "cpl": 0.25,
        "cpf": 1.25,
        "cpc_linkclick": 0.357,
        "frequency": 1.8,
        "children": [
          {
            "caption": "Late night version",
            "language": "en",
            "spotify_track_id": "11dFghVXANMlKmJXsNCbNl",
            "timestamp_start_ms": 45000,
            "timestamp_end_ms": 60000,
            "listeners": 200,
            "followers": 40,
            "link_clicks": 120,
            "cpl": 0.3,
            "cpf": 1.5,
            "cpc_linkclick": 0.5,
            "frequency": 2
          },
          {
            "caption": "Daytime version",
            "language": "en",
            "spotify_track_id": "11dFghVXANMlKmJXsNCbNl",
            "timestamp_start_ms": 0,
            "timestamp_end_ms": 15000,
            "listeners": 200,
            "followers": 40,
            "link_clicks": 160,
            "cpl": 0.2,
            "cpf": 1,
            "cpc_linkclick": 0.25,
            "frequency": 1.5
          }
        ]
      }
    ]
  },
  "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)

Response

Creative groups for the campaign

data

object

required

Show child attributes

meta

object

required

Show child attributes

Campaign creative metrics

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

import requests

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

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/creatives', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "creatives": [
      {
        "video_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "caption": "Late night version",
        "listeners": 400,
        "followers": 80,
        "link_clicks": 280,
        "cpl": 0.25,
        "cpf": 1.25,
        "cpc_linkclick": 0.357,
        "frequency": 1.8,
        "children": [
          {
            "caption": "Late night version",
            "language": "en",
            "spotify_track_id": "11dFghVXANMlKmJXsNCbNl",
            "timestamp_start_ms": 45000,
            "timestamp_end_ms": 60000,
            "listeners": 200,
            "followers": 40,
            "link_clicks": 120,
            "cpl": 0.3,
            "cpf": 1.5,
            "cpc_linkclick": 0.5,
            "frequency": 2
          },
          {
            "caption": "Daytime version",
            "language": "en",
            "spotify_track_id": "11dFghVXANMlKmJXsNCbNl",
            "timestamp_start_ms": 0,
            "timestamp_end_ms": 15000,
            "listeners": 200,
            "followers": 40,
            "link_clicks": 160,
            "cpl": 0.2,
            "cpf": 1,
            "cpc_linkclick": 0.25,
            "frequency": 1.5
          }
        ]
      }
    ]
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

System

Wallet

Campaigns

Soundlinks

Videos

Campaign creative metrics

Authorizations

Path Parameters

Response