API reference
Workspace Dashboard API
Read workspace launch checks, business aggregates and monthly goals with section-level team permissions.
Workspace-wide analytics, not unrestricted account data
Use GET /api/dashboard/launch-center for launch checks and the business command center, or GET /api/dashboard/command-center for the command center alone. Both require analytics.view and all-products workspace scope. They are first-party authenticated dashboard operations, not public product licensing calls.
Private customer snapshots require customers.view; billing state and monthly charges require billing.view; settlement balances require settlements.view; reseller health requires partners.view. Private activity follows orders.view and refunds.view. Restricted sections return available:false, restricted:true and requiredPermission rather than a fabricated zero balance or an empty customer history. Request parameters cannot expand these permissions.
Read the reporting and partial-response state
Use range with the supported dashboard range, currency=usd and environment=live or test. Sales analytics and current-month account charges cover different periods. A partial:true response with fallback_reason means heavier aggregates are unavailable or still loading, not zero revenue.
Readiness and supported reporting paths can initialize supporting records. Do not poll this workflow as a zero-write public health check. Owner-only payout setup, provider verification and financial execution remain separate workflows.
JUCE does not require a HISE package
Product credentials and successful plugin connection proof are shared licensing concepts. The dashboard labels recorded JUCE package use as JUCE, recorded HISE use as HISE, and mixed or unknown use as Plugin. A generated package is not by itself a successful activation or connection test.
No package recorded means no applicable generation event was found; it does not mean that HISE authentication is required. For a JUCE product, use its generated JUCE client and the plugin-connection guide. Do not rotate product credentials or install HISE merely to clear an unrelated label.
Licensing activity is not a manual-test requirement
Server-recorded successful activation and validation requests are recognized alongside Test Connection history. Published products are not marked incomplete or scored down solely because a test record is missing or old. Draft publication still follows its existing setup requirements.
Recent licensing activity means a server-recorded successful activation or validation in the past 24 hours using a current active product credential, excluding explicitly non-production activity. Existing licensing events without an environment marker are recognized. Connection tests require a production/live marker and are labelled separately. Historical, non-production, future-dated or revoked-credential evidence cannot claim current health. These are observations, not a continuous uptime monitor or a guarantee that every customer license is valid.
Read goals or save the complete target set
GET /api/dashboard/goals reads the current monthly targets. PUT saves them and additionally requires settings.manage; the current fixed roles permit the owner and administrators to save. The command-center goals.canManage value controls the editor, but the server still enforces the permission.
PUT is a complete target replacement: omitted revenue, download, customer and product targets become zero. Prefer explicit revenue_goal_cents, downloads_goal, customer_goal and products_goal. Omit month for the current UTC month or send its date, such as 2026-10-01. Targets do not change prices, charges, payout schedules or financial settings.
SoundSync
Read and replace monthly goals
curl --fail-with-body -sS "$SOUNDSYNC_API_BASE/api/dashboard/goals" \
-H "Authorization: Bearer $DEVELOPER_TOKEN"
curl --fail-with-body -sS -X PUT "$SOUNDSYNC_API_BASE/api/dashboard/goals" \
-H "Authorization: Bearer $DEVELOPER_TOKEN" \
-H "Content-Type: application/json" \
--data '{"month":"2026-10-01","revenue_goal_cents":100000,"downloads_goal":100,"customer_goal":25,"products_goal":3}'SoundSync
Requests and responses
/api/dashboard/launch-center
Read launch checks and permission-filtered business dashboard
- Auth
- Account Bearer JWT
- Scope
- analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
/api/dashboard/command-center
Read the permission-filtered business command center
- Auth
- Account Bearer JWT
- Scope
- analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
/api/dashboard/goals
Read saved monthly workspace goals
- Auth
- Account Bearer JWT
- Scope
- analytics.view and all-products workspace scope.
/api/dashboard/goals
Save monthly workspace goals
- Auth
- Account Bearer JWT
- Scope
- analytics.view, settings.manage and all-products scope; current fixed roles permit owner/administrator writes.