Live Report API

Read-only JSON access to your published coordination reports — pull live frequency lists and zone/group structure into show automation, dashboards, or custom tools.

The Live Report API returns the same data as a real-time report web page, as JSON. Anything you’ve published — a site, a zone, a group, or a custom report — can be fetched by machines.

Requirements

• A SoundBase Pro subscription on the account that owns the token.
• An API token, created in the web app under My Settings → Security → API Tokens. Tokens are shown once at creation — store them securely. (The Security tab lives in the browser app, not SoundBase Desktop.)
• The report must be published (enabled) — disabled publications return an error.

The endpoint

GET https://prod-rest-sync.soundbase.services/live-report/{projectId}?publication={keys}

Headers on every request:

• Authorization: Bearer sb_live_<prefix>_<secret> — or the same token in X-API-Key.
• X-Live-Report-Api-Version: 1.2.0 (current; 1.1.0 and 1.0.1 are also accepted).
• X-Publication-Password: … when the report is password-protected (or ?password=).

The projectId and publication values come straight out of the published report’s URL (…/publisher/coord/{projectId}?publication=…). Publication keys scope the response: {site}, {site}-{zone}, or {site}-{zone}-{group}, and a custom report’s key returns its curated selection.

Example

curl "https://prod-rest-sync.soundbase.services/live-report/PROJECT_ID?publication=SITE_KEY" \
  -H "Authorization: Bearer sb_live_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-Live-Report-Api-Version: 1.2.0"

Errors

Application errors return {"errorCode": "...", "message": "..."}:

Status	Codes
400	INVALID_PARAMS, API_VERSION_MISMATCH
401	UNAUTHORIZED (bad/revoked token, or the owner’s Pro entitlement lapsed)
403	FEATURE_DISABLED, PUBLICATION_DISABLED, INVALID_CREDENTIALS (wrong password)
404	NOT_FOUND

Rate limiting is per client IP (1000 requests/minute by default). A 429 response uses a different body shape (statusCode, error, message) and standard x-ratelimit-* / retry-after headers.

Integration notes

• Dates in the payload (group time-of-use fields) are serialized as {{timestamp}}<milliseconds-since-epoch> strings — strip the {{timestamp}} prefix and feed the number to new Date(Number(...)).
• Responses can be large for big coordinations; the service supports gzip, deflate, and br compression.
• The response schema is versioned by the X-Live-Report-Api-Version header; 1.2.0 additionally guarantees the sites array.

Full specification

The complete, always-current OpenAPI specification with schemas and examples is self-hosted by the API:

• Interactive docs: https://prod-rest-sync.soundbase.services/live-report/docs/
• Raw spec: …/live-report/docs/liveReportApi_1.2.0.yaml

Managing tokens

My Settings → Security → API Tokens lists your tokens with per-day usage counts. Tokens are named, you can hold several at once, and revoking one disables it immediately. A token stops working if the owning account’s Pro subscription lapses.