Live Report API

Read-only JSON access to published live frequency coordination reports. Requires SoundBase Pro, API version header X-Live-Report-Api-Version: 1.2.0 (or 1.1.0 / 1.0.1), and an API token.

Version 1.2.0 Pro subscription required GET only liveReportApi_1.2.0.yaml

Download OpenAPI spec

Quick start

1. Create an API token

In SoundBase, open My Settings → Security → API Tokens. Create a token and copy it immediately — it is only shown once.

2. Get the report URL components

Open the published report in a browser. Copy the project ID from the path and the publication (or customReport) query value — both use the same API publication param:

https://my.soundbase.app/publisher/coord/projectId?publication=siteKey-zoneKey-groupKey
https://my.soundbase.app/publisher/coord/projectId?customReport=customReportKey

3. Call the API

curl -s \
  -H "X-Live-Report-Api-Version: 1.2.0" \
  -H "Authorization: Bearer sb_live_<prefix>_<secret>" \
  -H "X-Publication-Password: your-report-password" \
  "https://prod-rest-sync.soundbase.services/live-report/<projectId>?publication=<siteKey>-<zoneKey>-<groupKey>"

The version header is required. Accepted values: 1.2.0 (current), 1.1.0, and 1.0.1. Spec file: liveReportApi_1.2.0.yaml.

4. Use the response

The JSON body includes project, site, sites, zones, groups, and frequenciesByGroup.