Public API

Build on Soundlink

Sync campaigns and metrics into your dashboards and data pipelines. Read-only Public API v1 with an official TypeScript SDK.

terminal
# List your campaigns
curl -sS 'https://api.getsoundlink.com/v1/campaigns?page=1&pageSize=10' \
  -H 'x-api-key: sk_YOUR_PREFIX_YOUR_SECRET'

# Metrics overview for a date range
curl -sS 'https://api.getsoundlink.com/v1/campaigns/camp_8x4kQ2/metrics/overview?startDate=2026-04-01&endDate=2026-04-30' \
  -H 'x-api-key: sk_YOUR_PREFIX_YOUR_SECRET'

# Per-country breakdown (paginated)
curl -sS 'https://api.getsoundlink.com/v1/campaigns/camp_8x4kQ2/metrics/breakdown?page=1&pageSize=50' \
  -H 'x-api-key: sk_YOUR_PREFIX_YOUR_SECRET'

What you can build

List campaigns, pull metrics, and export JSONL for warehouses — with REST or the official TypeScript SDK.

Campaign analytics

Pull real-time campaign performance data — streams, follows, conversions — into your own dashboards and BI tools.

Campaign management

Create, launch, and manage ad campaigns programmatically. Set budgets, targets, and schedules without touching the UI.

Custom dashboards

Build internal dashboards that combine Soundlink data with your own metrics — royalties, release calendars, ad spend across platforms.

Webhooks & events

Get notified in real time when campaigns hit milestones, budgets are exhausted, or performance thresholds are crossed.

Multi-artist orchestration

Labels and distributors can manage campaigns across their entire roster from a single integration point.

Secure by default

Personal access tokens, scoped API keys, rate limiting, and audit logs. Enterprise-grade from day one.

RESTful & predictable

Standard REST conventions. JSON in, JSON out. Consistent error codes, pagination, and filtering across every endpoint.

  • API key authentication (`x-api-key`)
  • Versioned endpoints (`/v1/*`)
  • Consistent `{ data, error, meta }` envelope
  • JSONL exports for pipeline ingest
  • Official `soundlink` npm package
GET /v1/campaigns/:campaignId/metrics/overview
{
  "data": {
    "listeners": 4821,
    "streams": 9340,
    "followers": 312,
    "spend_total": 134.5,
    "spend_media": 120.0,
    "cpl": 0.028,
    "cpf": 0.43,
    "streams_per_listener": 1.94,
    "currency": "USD"
  },
  "meta": { "requestId": "550e8400-..." }
}

Get API access

Public API access is enabled per organization. Book a demo to learn more about Soundlink and request an API key for your team.