Batch campaign creative metrics

POST

campaigns

metrics

creatives

batch

Batch campaign creative metrics

curl --request POST \
  --url https://api.getsoundlink.com/v1/campaigns/metrics/creatives/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignIds": [
    "f1e28d31-c358-4284-9bef-00a2334625fd",
    "a2b39e42-d469-5395-ac0f-11b3445736fe"
  ]
}
'

import requests

url = "https://api.getsoundlink.com/v1/campaigns/metrics/creatives/batch"

payload = { "campaignIds": ["f1e28d31-c358-4284-9bef-00a2334625fd", "a2b39e42-d469-5395-ac0f-11b3445736fe"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    campaignIds: ['f1e28d31-c358-4284-9bef-00a2334625fd', 'a2b39e42-d469-5395-ac0f-11b3445736fe']
  })
};

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

{
  "data": {
    "items": [
      {
        "campaignId": "<string>",
        "creatives": [
          {
            "video_id": "<string>",
            "caption": "<string>",
            "listeners": 123,
            "followers": 123,
            "link_clicks": 123,
            "cpl": 123,
            "cpf": 123,
            "cpc_linkclick": 123,
            "frequency": 123,
            "children": [
              {
                "caption": "<string>",
                "language": "<string>",
                "spotify_track_id": "<string>",
                "timestamp_start_ms": 123,
                "timestamp_end_ms": 123,
                "listeners": 123,
                "followers": 123,
                "link_clicks": 123,
                "cpl": 123,
                "cpf": 123,
                "cpc_linkclick": 123,
                "frequency": 123
              }
            ]
          }
        ]
      }
    ]
  },
  "meta": {
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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.

Body

application/json

campaignIds

string[]

required

Campaign IDs to fetch. Duplicates are ignored. Max 50.

Required array length: 1 - 50 elements

Minimum string length: 1

Response

Creative metrics per authorized campaign

data

object

required

Show child attributes

meta

object

required

Show child attributes

Batch campaign creative metrics

curl --request POST \
  --url https://api.getsoundlink.com/v1/campaigns/metrics/creatives/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignIds": [
    "f1e28d31-c358-4284-9bef-00a2334625fd",
    "a2b39e42-d469-5395-ac0f-11b3445736fe"
  ]
}
'

import requests

url = "https://api.getsoundlink.com/v1/campaigns/metrics/creatives/batch"

payload = { "campaignIds": ["f1e28d31-c358-4284-9bef-00a2334625fd", "a2b39e42-d469-5395-ac0f-11b3445736fe"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    campaignIds: ['f1e28d31-c358-4284-9bef-00a2334625fd', 'a2b39e42-d469-5395-ac0f-11b3445736fe']
  })
};

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

{
  "data": {
    "items": [
      {
        "campaignId": "<string>",
        "creatives": [
          {
            "video_id": "<string>",
            "caption": "<string>",
            "listeners": 123,
            "followers": 123,
            "link_clicks": 123,
            "cpl": 123,
            "cpf": 123,
            "cpc_linkclick": 123,
            "frequency": 123,
            "children": [
              {
                "caption": "<string>",
                "language": "<string>",
                "spotify_track_id": "<string>",
                "timestamp_start_ms": 123,
                "timestamp_end_ms": 123,
                "listeners": 123,
                "followers": 123,
                "link_clicks": 123,
                "cpl": 123,
                "cpf": 123,
                "cpc_linkclick": 123,
                "frequency": 123
              }
            ]
          }
        ]
      }
    ]
  },
  "meta": {
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

System

Wallet

Campaigns

Soundlinks

Videos

Pixels

Batch campaign creative metrics

Authorizations

Body

Response