Soundlink metrics overview

GET

soundlinks

{soundlinkId}

metrics

overview

Soundlink metrics overview

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

import requests

url = "https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/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/soundlinks/{soundlinkId}/metrics/overview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "views": 4821,
    "link_clicks": 890,
    "streams": 9340,
    "listeners": 3980,
    "followers": 312,
    "streams_per_listener": 2.35,
    "ctr_lp": 0.185
  },
  "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

soundlinkId

string

required

Soundlink identifier (URL-safe string, same ID used in the public sndl.ink URL)

Query Parameters

startDate

string<date>

Inclusive start date (YYYY-MM-DD) for soundlink overview and breakdown. Defaults to the soundlink creation date when omitted.

endDate

string<date>

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

Response

Soundlink totals

data

object

required

Soundlink-level totals for the requested date range. Additive fields are sums of api_smart_link_country_daily country-day rows.

Show child attributes

meta

object

required

Show child attributes

Soundlink metrics overview

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

import requests

url = "https://api.getsoundlink.com/v1/soundlinks/{soundlinkId}/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/soundlinks/{soundlinkId}/metrics/overview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "views": 4821,
    "link_clicks": 890,
    "streams": 9340,
    "listeners": 3980,
    "followers": 312,
    "streams_per_listener": 2.35,
    "ctr_lp": 0.185
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

System

Campaigns

Soundlinks

Videos

Soundlink metrics overview

Authorizations

Path Parameters

Query Parameters

Response