# Soundlink API

## Docs

- [Get campaign](https://www.getsoundlink.com/docs/api-reference/campaigns/get-campaign.md): Fetch full details for a single campaign.
- [List campaigns](https://www.getsoundlink.com/docs/api-reference/campaigns/list-campaigns.md): Returns all campaigns for the authenticated organization. Intended for reporting and data warehouse sync.
- [Campaign engagement breakdown](https://www.getsoundlink.com/docs/api-reference/metrics/campaign-engagement-breakdown.md): Per-day, per-track engagement metrics for a campaign. One row per `(report_date, campaign_id, engagement_context, engaged_spotify_track_id)`.
- [Campaign engagement export (JSONL)](https://www.getsoundlink.com/docs/api-reference/metrics/campaign-engagement-export-jsonl.md): Streams the full engagement dataset for a campaign as **newline-delimited JSON (JSONL)**. Every line is a complete, valid JSON object conforming to the `campaign_engagement_daily` v1.0 schema — identical to the rows returned by `GET /metrics/engagement` but without pagination or an envelope wrapper.
- [Campaign metrics breakdown](https://www.getsoundlink.com/docs/api-reference/metrics/campaign-metrics-breakdown.md): Per-day metrics broken down by country. One row per `(report_date, campaign_id, country_code)`. Can be large, so results are paginated.
- [Campaign metrics breakdown export (JSONL)](https://www.getsoundlink.com/docs/api-reference/metrics/campaign-metrics-breakdown-export-jsonl.md): Streams the full country-level metrics dataset for a campaign as **newline-delimited JSON (JSONL)**. Every line is a complete, valid JSON object conforming to the `campaign_country_daily` v1.0 schema — identical to the rows returned by `GET /metrics/breakdown` but without pagination or an envelope w…
- [Campaign metrics overview](https://www.getsoundlink.com/docs/api-reference/metrics/campaign-metrics-overview.md): Campaign-level totals for a date range: spend, conversions, listeners, streams, followers, and derived ratios. No per-day rows — use `/metrics/breakdown` for those.
- [Verify connectivity and authentication](https://www.getsoundlink.com/docs/api-reference/system/verify-connectivity-and-authentication.md): Returns `{ "status": "ok" }` if the request is authenticated and the API is reachable. Useful for verifying a newly issued key before making data requests.
- [Authentication](https://www.getsoundlink.com/docs/authentication.md): API keys, scopes, and security expectations for the Public API.
- [Errors](https://www.getsoundlink.com/docs/errors.md): Standard error codes and HTTP status mapping for the Public API v1.
- [Introduction](https://www.getsoundlink.com/docs/index.md): Sync Soundlink campaigns and metrics into your tools, warehouses, and apps.
- [JSONL exports](https://www.getsoundlink.com/docs/jsonl-exports.md): Bulk metrics downloads for data pipelines without pagination.
- [Quickstart](https://www.getsoundlink.com/docs/quickstart.md): Verify your API key and fetch your first campaign list.
- [Official SDKs](https://www.getsoundlink.com/docs/sdks.md): When to use the TypeScript SDK vs raw HTTP for the Soundlink Public API.
- [Syncing campaigns](https://www.getsoundlink.com/docs/syncing-campaigns.md): List and detail endpoints for keeping your campaign catalog in sync.
- [Access the API with TypeScript](https://www.getsoundlink.com/docs/typescript-sdk.md): Install the soundlink SDK and call campaigns and metrics from Node.js or Edge.
- [Understanding metrics](https://www.getsoundlink.com/docs/understanding-metrics.md): When to use overview, breakdown, and engagement endpoints.

## OpenAPI Specs

- [soundlink-public-api-v1](https://www.getsoundlink.com/docs/openapi/soundlink-public-api-v1.yaml)