Skip to content
SoundSyncAudio software platform

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 America/New_York 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

Illustrative owner or administrator request
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

GET /api/dashboard/launch-center

Read launch checks and permission-filtered business dashboard

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
Request fields
  • query range: string
  • query currency: value
  • query environment: value
Returns
HTTP 200: developer_id, generated_at, goLiveReady, completionPercent, status, blockingCount, warningCount, readiness, nextAction, checklist, issues, summaryCards, counts, health, commandCenter.
Notes
First-party dashboard contract. customers.view gates private customer snapshots; billing.view gates billing state and current-month charges; settlements.view gates balances; partners.view gates reseller health. Private order/refund activity follows orders.view/refunds.view. Restricted sections are unavailable, not zero activity. Request query/body data cannot add permissions. A partial response means heavy aggregates timed out or failed, not verified zero sales. Readiness and supported reporting paths can initialize supporting records; do not use this as a zero-write public uptime probe. Package labels reflect recorded JUCE/HISE generation or remain framework-neutral. No HISE package is required for a JUCE product; saved credentials, generated packages and successful connection proof are distinct.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "currency",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "usd",
        "USD"
      ]
    }
  },
  {
    "name": "environment",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "test",
        "live"
      ]
    }
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "developer_id": {
      "type": "integer",
      "minimum": 1
    },
    "generated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "goLiveReady": {
      "type": "boolean"
    },
    "completionPercent": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "blockingCount": {
      "type": "integer"
    },
    "warningCount": {
      "type": "integer"
    },
    "readiness": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "nextAction": {
      "type": [
        "object",
        "null"
      ]
    },
    "checklist": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "issues": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "summaryCards": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "counts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "health": {
      "type": "object",
      "properties": {
        "products": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "storefront": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "marketplace": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "billing": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "accountStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "currentInvoiceStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "pastDue": {
                  "type": "boolean"
                },
                "amountDueCents": {
                  "type": "integer"
                },
                "failedAmountCents": {
                  "type": "integer"
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "settlement": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "accountStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "payoutHold": {
                  "type": "boolean"
                },
                "availableBalanceCents": {
                  "type": "integer"
                },
                "pendingBalanceCents": {
                  "type": "integer"
                },
                "payoutMethodStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "reseller": {
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "expansion": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        }
      },
      "additionalProperties": true
    },
    "commandCenter": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "period_start": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "period_end": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "currency": {
          "type": "string"
        },
        "environment": {
          "type": "string"
        },
        "partial": {
          "type": "boolean"
        },
        "fallback_reason": {
          "type": "string"
        },
        "access": {
          "type": "object",
          "properties": {
            "customers": {
              "type": "boolean"
            },
            "billing": {
              "type": "boolean"
            },
            "settlements": {
              "type": "boolean"
            },
            "orders": {
              "type": "boolean"
            },
            "refunds": {
              "type": "boolean"
            },
            "marketing": {
              "type": "boolean"
            },
            "partners": {
              "type": "boolean"
            },
            "manageGoals": {
              "type": "boolean"
            }
          },
          "additionalProperties": true
        },
        "kpis": {
          "type": "object",
          "properties": {
            "revenue": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "sales": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "subscriptions": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "customers": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "products": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "downloads": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "activations": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "external_redemptions": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "customer_snapshot": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "new_this_month": {
                  "type": "integer"
                },
                "returning_percentage": {
                  "type": "number"
                },
                "countries_count": {
                  "type": "integer"
                },
                "top_country": {
                  "type": "string"
                },
                "top_country_percentage": {
                  "type": "number"
                },
                "recent_customers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "name": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "format": "email"
                      },
                      "country": {
                        "type": "string"
                      },
                      "occurred_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "href": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "customerSnapshot": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "new_this_month": {
                  "type": "integer"
                },
                "returning_percentage": {
                  "type": "number"
                },
                "countries_count": {
                  "type": "integer"
                },
                "top_country": {
                  "type": "string"
                },
                "top_country_percentage": {
                  "type": "number"
                },
                "recent_customers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "name": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "format": "email"
                      },
                      "country": {
                        "type": "string"
                      },
                      "occurred_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "href": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "current_month_charges": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "available": {
                  "type": "boolean"
                },
                "marketing_email_charges_cents": {
                  "type": "integer"
                },
                "redemption_overage_charges_cents": {
                  "type": "integer"
                },
                "minimum_adjustment_cents": {
                  "type": "integer"
                },
                "current_total_if_billed_today_cents": {
                  "type": "integer"
                },
                "pre_minimum_total_cents": {
                  "type": "integer"
                },
                "line_items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                  }
                },
                "lineItems": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                  }
                },
                "marketing_emails": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                },
                "external_redemptions": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "revenue_breakdown": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "revenue_snapshot": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "revenueSnapshot": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "business_health": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "businessHealth": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "attention": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "action_center": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "actionCenter": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "recent_activity": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "activity_feed": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "activityFeed": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "products": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "product_health": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "productHealth": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "integrations": {
          "type": "object",
          "properties": {
            "rows": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "last_plugin_connection": {
              "type": [
                "object",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "goals": {
          "type": "object",
          "properties": {
            "month": {
              "type": "string"
            },
            "revenue_goal_cents": {
              "type": "integer"
            },
            "downloads_goal": {
              "type": "integer"
            },
            "customer_goal": {
              "type": "integer"
            },
            "products_goal": {
              "type": "integer"
            },
            "persisted": {
              "type": "boolean"
            },
            "canManage": {
              "type": "boolean"
            },
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "current": {
                    "type": "number"
                  },
                  "target": {
                    "type": "number"
                  },
                  "unit": {
                    "type": "string"
                  },
                  "percentage": {
                    "type": "number"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        "marketplace": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "developer_health_score": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "developerHealthScore": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "opportunities": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "backend_gaps": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.

GET /api/dashboard/command-center

Read the permission-filtered business command center

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
Request fields
  • query range: string
  • query currency: value
  • query environment: value
Returns
HTTP 200: range, period_start, period_end, currency, environment, partial, fallback_reason, access, kpis, customer_snapshot, customerSnapshot, current_month_charges, revenue_breakdown, revenue_snapshot, revenueSnapshot, business_health, businessHealth, attention, action_center, actionCenter, recent_activity, activity_feed, activityFeed, products, product_health, productHealth, integrations, goals, marketplace, developer_health_score, developerHealthScore, opportunities, backend_gaps.
Notes
First-party dashboard contract. customers.view gates private customer snapshots; billing.view gates billing state and current-month charges; settlements.view gates balances; partners.view gates reseller health. Private order/refund activity follows orders.view/refunds.view. Restricted sections are unavailable, not zero activity. Request query/body data cannot add permissions. A partial response means heavy aggregates timed out or failed, not verified zero sales. Readiness and supported reporting paths can initialize supporting records; do not use this as a zero-write public uptime probe. Package labels reflect recorded JUCE/HISE generation or remain framework-neutral. No HISE package is required for a JUCE product; saved credentials, generated packages and successful connection proof are distinct.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "currency",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "usd",
        "USD"
      ]
    }
  },
  {
    "name": "environment",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "test",
        "live"
      ]
    }
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string"
    },
    "period_start": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "period_end": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "currency": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "partial": {
      "type": "boolean"
    },
    "fallback_reason": {
      "type": "string"
    },
    "access": {
      "type": "object",
      "properties": {
        "customers": {
          "type": "boolean"
        },
        "billing": {
          "type": "boolean"
        },
        "settlements": {
          "type": "boolean"
        },
        "orders": {
          "type": "boolean"
        },
        "refunds": {
          "type": "boolean"
        },
        "marketing": {
          "type": "boolean"
        },
        "partners": {
          "type": "boolean"
        },
        "manageGoals": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "kpis": {
      "type": "object",
      "properties": {
        "revenue": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "sales": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "subscriptions": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "customers": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "products": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "downloads": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "activations": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "external_redemptions": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "customer_snapshot": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "new_this_month": {
              "type": "integer"
            },
            "returning_percentage": {
              "type": "number"
            },
            "countries_count": {
              "type": "integer"
            },
            "top_country": {
              "type": "string"
            },
            "top_country_percentage": {
              "type": "number"
            },
            "recent_customers": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "country": {
                    "type": "string"
                  },
                  "occurred_at": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "customerSnapshot": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "new_this_month": {
              "type": "integer"
            },
            "returning_percentage": {
              "type": "number"
            },
            "countries_count": {
              "type": "integer"
            },
            "top_country": {
              "type": "string"
            },
            "top_country_percentage": {
              "type": "number"
            },
            "recent_customers": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "country": {
                    "type": "string"
                  },
                  "occurred_at": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "current_month_charges": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "marketing_email_charges_cents": {
              "type": "integer"
            },
            "redemption_overage_charges_cents": {
              "type": "integer"
            },
            "minimum_adjustment_cents": {
              "type": "integer"
            },
            "current_total_if_billed_today_cents": {
              "type": "integer"
            },
            "pre_minimum_total_cents": {
              "type": "integer"
            },
            "line_items": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
              }
            },
            "lineItems": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
              }
            },
            "marketing_emails": {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            },
            "external_redemptions": {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "revenue_breakdown": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "revenue_snapshot": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "revenueSnapshot": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "business_health": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessHealth": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "attention": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "action_center": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "actionCenter": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "recent_activity": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "activity_feed": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "activityFeed": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "product_health": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "productHealth": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "integrations": {
      "type": "object",
      "properties": {
        "rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "href": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "last_plugin_connection": {
          "type": [
            "object",
            "null"
          ]
        }
      },
      "additionalProperties": true
    },
    "goals": {
      "type": "object",
      "properties": {
        "month": {
          "type": "string"
        },
        "revenue_goal_cents": {
          "type": "integer"
        },
        "downloads_goal": {
          "type": "integer"
        },
        "customer_goal": {
          "type": "integer"
        },
        "products_goal": {
          "type": "integer"
        },
        "persisted": {
          "type": "boolean"
        },
        "canManage": {
          "type": "boolean"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "current": {
                "type": "number"
              },
              "target": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "percentage": {
                "type": "number"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "marketplace": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "developer_health_score": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "developerHealthScore": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "opportunities": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "backend_gaps": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.

GET /api/dashboard/goals

Read saved monthly workspace goals

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope.
Returns
HTTP 200: month, revenue_goal_cents, downloads_goal, customer_goal, products_goal, persisted, canManage, items.
Notes
Returns the current monthly goals or a default empty goal configuration. Reading goals is not authorization to change them.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string"
    },
    "revenue_goal_cents": {
      "type": "integer"
    },
    "downloads_goal": {
      "type": "integer"
    },
    "customer_goal": {
      "type": "integer"
    },
    "products_goal": {
      "type": "integer"
    },
    "persisted": {
      "type": "boolean"
    },
    "canManage": {
      "type": "boolean"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "current": {
            "type": "number"
          },
          "target": {
            "type": "number"
          },
          "unit": {
            "type": "string"
          },
          "percentage": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PUT /api/dashboard/goals

Save monthly workspace goals

Auth
Account Bearer session token
Scope
analytics.view, settings.manage and all-products scope; current fixed roles permit owner/administrator writes.
Request fields
  • month: string
  • revenue_goal_cents: number
  • revenueGoalCents: number
  • revenue_goal: number
  • revenueGoal: number
  • downloads_goal: number
  • downloadsGoal: number
  • customer_goal: number
  • customerGoal: number
  • products_goal: number
  • productsGoal: number
Returns
HTTP 200: month, revenue_goal_cents, downloads_goal, customer_goal, products_goal, persisted, canManage, items.
Notes
Whole-goal replacement, not a sparse update: omitted targets become zero. Values are rounded and clamped to nonnegative integers; revenue_goal/revenueGoal are dollar aliases, while revenue_goal_cents/revenueGoalCents are cents. Omit month for the current America/New_York month; send a valid date such as 2026-10-01 for an explicit month. A successful write returns persisted:true. Saving a target changes no product prices, fees, payout settings or financial flags.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string",
      "format": "date"
    },
    "revenue_goal_cents": {
      "type": "number"
    },
    "revenueGoalCents": {
      "type": "number"
    },
    "revenue_goal": {
      "type": "number"
    },
    "revenueGoal": {
      "type": "number"
    },
    "downloads_goal": {
      "type": "number"
    },
    "downloadsGoal": {
      "type": "number"
    },
    "customer_goal": {
      "type": "number"
    },
    "customerGoal": {
      "type": "number"
    },
    "products_goal": {
      "type": "number"
    },
    "productsGoal": {
      "type": "number"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string"
    },
    "revenue_goal_cents": {
      "type": "integer"
    },
    "downloads_goal": {
      "type": "integer"
    },
    "customer_goal": {
      "type": "integer"
    },
    "products_goal": {
      "type": "integer"
    },
    "persisted": {
      "type": "boolean"
    },
    "canManage": {
      "type": "boolean"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "current": {
            "type": "number"
          },
          "target": {
            "type": "number"
          },
          "unit": {
            "type": "string"
          },
          "percentage": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, DASHBOARD_GOALS_TABLE_MISSING.

GET /api/developer/dashboard/launch-center

Read launch checks and permission-filtered business dashboard

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
Request fields
  • query range: string
  • query currency: value
  • query environment: value
Returns
HTTP 200: developer_id, generated_at, goLiveReady, completionPercent, status, blockingCount, warningCount, readiness, nextAction, checklist, issues, summaryCards, counts, health, commandCenter.
Notes
First-party dashboard contract. customers.view gates private customer snapshots; billing.view gates billing state and current-month charges; settlements.view gates balances; partners.view gates reseller health. Private order/refund activity follows orders.view/refunds.view. Restricted sections are unavailable, not zero activity. Request query/body data cannot add permissions. A partial response means heavy aggregates timed out or failed, not verified zero sales. Readiness and supported reporting paths can initialize supporting records; do not use this as a zero-write public uptime probe. Package labels reflect recorded JUCE/HISE generation or remain framework-neutral. No HISE package is required for a JUCE product; saved credentials, generated packages and successful connection proof are distinct. Active compatibility alias of /api/dashboard with the same handlers and permission checks; prefer the canonical /api/dashboard path for new clients.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "currency",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "usd",
        "USD"
      ]
    }
  },
  {
    "name": "environment",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "test",
        "live"
      ]
    }
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "developer_id": {
      "type": "integer",
      "minimum": 1
    },
    "generated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "goLiveReady": {
      "type": "boolean"
    },
    "completionPercent": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "blockingCount": {
      "type": "integer"
    },
    "warningCount": {
      "type": "integer"
    },
    "readiness": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "nextAction": {
      "type": [
        "object",
        "null"
      ]
    },
    "checklist": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "issues": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "summaryCards": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "counts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "health": {
      "type": "object",
      "properties": {
        "products": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "storefront": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "marketplace": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "billing": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "accountStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "currentInvoiceStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "pastDue": {
                  "type": "boolean"
                },
                "amountDueCents": {
                  "type": "integer"
                },
                "failedAmountCents": {
                  "type": "integer"
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "settlement": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "accountStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "payoutHold": {
                  "type": "boolean"
                },
                "availableBalanceCents": {
                  "type": "integer"
                },
                "pendingBalanceCents": {
                  "type": "integer"
                },
                "payoutMethodStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "reseller": {
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "expansion": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        }
      },
      "additionalProperties": true
    },
    "commandCenter": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "period_start": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "period_end": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "currency": {
          "type": "string"
        },
        "environment": {
          "type": "string"
        },
        "partial": {
          "type": "boolean"
        },
        "fallback_reason": {
          "type": "string"
        },
        "access": {
          "type": "object",
          "properties": {
            "customers": {
              "type": "boolean"
            },
            "billing": {
              "type": "boolean"
            },
            "settlements": {
              "type": "boolean"
            },
            "orders": {
              "type": "boolean"
            },
            "refunds": {
              "type": "boolean"
            },
            "marketing": {
              "type": "boolean"
            },
            "partners": {
              "type": "boolean"
            },
            "manageGoals": {
              "type": "boolean"
            }
          },
          "additionalProperties": true
        },
        "kpis": {
          "type": "object",
          "properties": {
            "revenue": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "sales": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "subscriptions": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "customers": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "products": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "downloads": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "activations": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "external_redemptions": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "customer_snapshot": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "new_this_month": {
                  "type": "integer"
                },
                "returning_percentage": {
                  "type": "number"
                },
                "countries_count": {
                  "type": "integer"
                },
                "top_country": {
                  "type": "string"
                },
                "top_country_percentage": {
                  "type": "number"
                },
                "recent_customers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "name": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "format": "email"
                      },
                      "country": {
                        "type": "string"
                      },
                      "occurred_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "href": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "customerSnapshot": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "new_this_month": {
                  "type": "integer"
                },
                "returning_percentage": {
                  "type": "number"
                },
                "countries_count": {
                  "type": "integer"
                },
                "top_country": {
                  "type": "string"
                },
                "top_country_percentage": {
                  "type": "number"
                },
                "recent_customers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "name": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "format": "email"
                      },
                      "country": {
                        "type": "string"
                      },
                      "occurred_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "href": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "current_month_charges": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "available": {
                  "type": "boolean"
                },
                "marketing_email_charges_cents": {
                  "type": "integer"
                },
                "redemption_overage_charges_cents": {
                  "type": "integer"
                },
                "minimum_adjustment_cents": {
                  "type": "integer"
                },
                "current_total_if_billed_today_cents": {
                  "type": "integer"
                },
                "pre_minimum_total_cents": {
                  "type": "integer"
                },
                "line_items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                  }
                },
                "lineItems": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                  }
                },
                "marketing_emails": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                },
                "external_redemptions": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "revenue_breakdown": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "revenue_snapshot": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "revenueSnapshot": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "business_health": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "businessHealth": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "attention": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "action_center": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "actionCenter": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "recent_activity": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "activity_feed": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "activityFeed": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "products": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "product_health": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "productHealth": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "integrations": {
          "type": "object",
          "properties": {
            "rows": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "last_plugin_connection": {
              "type": [
                "object",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "goals": {
          "type": "object",
          "properties": {
            "month": {
              "type": "string"
            },
            "revenue_goal_cents": {
              "type": "integer"
            },
            "downloads_goal": {
              "type": "integer"
            },
            "customer_goal": {
              "type": "integer"
            },
            "products_goal": {
              "type": "integer"
            },
            "persisted": {
              "type": "boolean"
            },
            "canManage": {
              "type": "boolean"
            },
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "current": {
                    "type": "number"
                  },
                  "target": {
                    "type": "number"
                  },
                  "unit": {
                    "type": "string"
                  },
                  "percentage": {
                    "type": "number"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        "marketplace": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "developer_health_score": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "developerHealthScore": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "opportunities": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "backend_gaps": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.

GET /api/developer/dashboard/command-center

Read the permission-filtered business command center

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
Request fields
  • query range: string
  • query currency: value
  • query environment: value
Returns
HTTP 200: range, period_start, period_end, currency, environment, partial, fallback_reason, access, kpis, customer_snapshot, customerSnapshot, current_month_charges, revenue_breakdown, revenue_snapshot, revenueSnapshot, business_health, businessHealth, attention, action_center, actionCenter, recent_activity, activity_feed, activityFeed, products, product_health, productHealth, integrations, goals, marketplace, developer_health_score, developerHealthScore, opportunities, backend_gaps.
Notes
First-party dashboard contract. customers.view gates private customer snapshots; billing.view gates billing state and current-month charges; settlements.view gates balances; partners.view gates reseller health. Private order/refund activity follows orders.view/refunds.view. Restricted sections are unavailable, not zero activity. Request query/body data cannot add permissions. A partial response means heavy aggregates timed out or failed, not verified zero sales. Readiness and supported reporting paths can initialize supporting records; do not use this as a zero-write public uptime probe. Package labels reflect recorded JUCE/HISE generation or remain framework-neutral. No HISE package is required for a JUCE product; saved credentials, generated packages and successful connection proof are distinct. Active compatibility alias of /api/dashboard with the same handlers and permission checks; prefer the canonical /api/dashboard path for new clients.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "currency",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "usd",
        "USD"
      ]
    }
  },
  {
    "name": "environment",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "test",
        "live"
      ]
    }
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string"
    },
    "period_start": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "period_end": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "currency": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "partial": {
      "type": "boolean"
    },
    "fallback_reason": {
      "type": "string"
    },
    "access": {
      "type": "object",
      "properties": {
        "customers": {
          "type": "boolean"
        },
        "billing": {
          "type": "boolean"
        },
        "settlements": {
          "type": "boolean"
        },
        "orders": {
          "type": "boolean"
        },
        "refunds": {
          "type": "boolean"
        },
        "marketing": {
          "type": "boolean"
        },
        "partners": {
          "type": "boolean"
        },
        "manageGoals": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "kpis": {
      "type": "object",
      "properties": {
        "revenue": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "sales": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "subscriptions": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "customers": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "products": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "downloads": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "activations": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "external_redemptions": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "customer_snapshot": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "new_this_month": {
              "type": "integer"
            },
            "returning_percentage": {
              "type": "number"
            },
            "countries_count": {
              "type": "integer"
            },
            "top_country": {
              "type": "string"
            },
            "top_country_percentage": {
              "type": "number"
            },
            "recent_customers": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "country": {
                    "type": "string"
                  },
                  "occurred_at": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "customerSnapshot": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "new_this_month": {
              "type": "integer"
            },
            "returning_percentage": {
              "type": "number"
            },
            "countries_count": {
              "type": "integer"
            },
            "top_country": {
              "type": "string"
            },
            "top_country_percentage": {
              "type": "number"
            },
            "recent_customers": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "country": {
                    "type": "string"
                  },
                  "occurred_at": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "current_month_charges": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "marketing_email_charges_cents": {
              "type": "integer"
            },
            "redemption_overage_charges_cents": {
              "type": "integer"
            },
            "minimum_adjustment_cents": {
              "type": "integer"
            },
            "current_total_if_billed_today_cents": {
              "type": "integer"
            },
            "pre_minimum_total_cents": {
              "type": "integer"
            },
            "line_items": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
              }
            },
            "lineItems": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
              }
            },
            "marketing_emails": {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            },
            "external_redemptions": {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "revenue_breakdown": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "revenue_snapshot": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "revenueSnapshot": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "business_health": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessHealth": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "attention": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "action_center": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "actionCenter": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "recent_activity": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "activity_feed": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "activityFeed": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "product_health": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "productHealth": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "integrations": {
      "type": "object",
      "properties": {
        "rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "href": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "last_plugin_connection": {
          "type": [
            "object",
            "null"
          ]
        }
      },
      "additionalProperties": true
    },
    "goals": {
      "type": "object",
      "properties": {
        "month": {
          "type": "string"
        },
        "revenue_goal_cents": {
          "type": "integer"
        },
        "downloads_goal": {
          "type": "integer"
        },
        "customer_goal": {
          "type": "integer"
        },
        "products_goal": {
          "type": "integer"
        },
        "persisted": {
          "type": "boolean"
        },
        "canManage": {
          "type": "boolean"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "current": {
                "type": "number"
              },
              "target": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "percentage": {
                "type": "number"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "marketplace": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "developer_health_score": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "developerHealthScore": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "opportunities": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "backend_gaps": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.

GET /api/developer/dashboard/goals

Read saved monthly workspace goals

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope.
Returns
HTTP 200: month, revenue_goal_cents, downloads_goal, customer_goal, products_goal, persisted, canManage, items.
Notes
Returns the current monthly goals or a default empty goal configuration. Reading goals is not authorization to change them. Active compatibility alias of /api/dashboard with the same handlers and permission checks; prefer the canonical /api/dashboard path for new clients.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string"
    },
    "revenue_goal_cents": {
      "type": "integer"
    },
    "downloads_goal": {
      "type": "integer"
    },
    "customer_goal": {
      "type": "integer"
    },
    "products_goal": {
      "type": "integer"
    },
    "persisted": {
      "type": "boolean"
    },
    "canManage": {
      "type": "boolean"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "current": {
            "type": "number"
          },
          "target": {
            "type": "number"
          },
          "unit": {
            "type": "string"
          },
          "percentage": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PUT /api/developer/dashboard/goals

Save monthly workspace goals

Auth
Account Bearer session token
Scope
analytics.view, settings.manage and all-products scope; current fixed roles permit owner/administrator writes.
Request fields
  • month: string
  • revenue_goal_cents: number
  • revenueGoalCents: number
  • revenue_goal: number
  • revenueGoal: number
  • downloads_goal: number
  • downloadsGoal: number
  • customer_goal: number
  • customerGoal: number
  • products_goal: number
  • productsGoal: number
Returns
HTTP 200: month, revenue_goal_cents, downloads_goal, customer_goal, products_goal, persisted, canManage, items.
Notes
Whole-goal replacement, not a sparse update: omitted targets become zero. Values are rounded and clamped to nonnegative integers; revenue_goal/revenueGoal are dollar aliases, while revenue_goal_cents/revenueGoalCents are cents. Omit month for the current America/New_York month; send a valid date such as 2026-10-01 for an explicit month. A successful write returns persisted:true. Saving a target changes no product prices, fees, payout settings or financial flags. Active compatibility alias of /api/dashboard with the same handlers and permission checks; prefer the canonical /api/dashboard path for new clients.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string",
      "format": "date"
    },
    "revenue_goal_cents": {
      "type": "number"
    },
    "revenueGoalCents": {
      "type": "number"
    },
    "revenue_goal": {
      "type": "number"
    },
    "revenueGoal": {
      "type": "number"
    },
    "downloads_goal": {
      "type": "number"
    },
    "downloadsGoal": {
      "type": "number"
    },
    "customer_goal": {
      "type": "number"
    },
    "customerGoal": {
      "type": "number"
    },
    "products_goal": {
      "type": "number"
    },
    "productsGoal": {
      "type": "number"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string"
    },
    "revenue_goal_cents": {
      "type": "integer"
    },
    "downloads_goal": {
      "type": "integer"
    },
    "customer_goal": {
      "type": "integer"
    },
    "products_goal": {
      "type": "integer"
    },
    "persisted": {
      "type": "boolean"
    },
    "canManage": {
      "type": "boolean"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "current": {
            "type": "number"
          },
          "target": {
            "type": "number"
          },
          "unit": {
            "type": "string"
          },
          "percentage": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, DASHBOARD_GOALS_TABLE_MISSING.

GET /api/developer/notifications

Read actionable developer workspace notices

Auth
Account Bearer session token
Scope
workspace.view and active selected-workspace access. Billing and email sources require all-products scope and billing.view/marketing.view respectively. Product notices require products.view and stay assigned-product scoped. Additional sources use existing orders, refunds, customers, serials, domains, payouts, team, API/webhook and partner permissions; private details remain permission-filtered.
Returns
HTTP 200: workspaceId, developerId, checkedAt, unavailable, notices, activity, activityWindowDays, activityLimit.
Notes
Read-only: does not create a billing customer, change cards, reserve spend, dispatch email or send money. notices contains current actionable checks; unavailable names sources that could not be checked. An empty list is not proof of healthy sources when unavailable is nonempty. Source results can be cached for 60 seconds per effective developer, workspace, permission set and product scope; checkedAt is the collection time, not a telemetry guarantee. Successful responses are private,no-store. Read state is kept by the maintained browser client, not written through this endpoint; marking read does not resolve the issue. A workspace-required account notice is generated locally after session discovery and is not a successful response from this endpoint. Historical missing plugin-test evidence alone does not produce a live connection-failure notice. Notices and Activity are separate. Activity contains at most 50 grouped updates from the last 14 days and does not increase the warning count. Durable incident and milestone state is separate from browser-local unread markers. Resolution/retry/deadline fields are informational; reading or marking read never retries work, dismisses an active issue or changes account permissions.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "integer",
      "minimum": 1
    },
    "developerId": {
      "type": "integer",
      "minimum": 1
    },
    "checkedAt": {
      "type": "string",
      "format": "date-time"
    },
    "unavailable": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "severity": {
            "type": "string",
            "enum": [
              "warning",
              "error"
            ]
          },
          "title": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "actionLabel": {
            "type": "string"
          },
          "revision": {
            "type": "string"
          },
          "retryText": {
            "type": "string"
          },
          "resolution": {
            "type": "string"
          },
          "incidentId": {
            "type": [
              "string",
              "null"
            ]
          },
          "urgency": {
            "type": [
              "string",
              "null"
            ]
          },
          "affected": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "label": {
                  "type": "string"
                },
                "href": {
                  "type": "string"
                },
                "reason": {
                  "type": "string"
                },
                "retryText": {
                  "type": "string"
                },
                "resolution": {
                  "type": "string"
                },
                "nextRetryAt": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "deadlineAt": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "count": {
                  "type": "number"
                },
                "unit": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            }
          }
        },
        "additionalProperties": true,
        "required": [
          "id",
          "severity",
          "title",
          "message",
          "href",
          "actionLabel",
          "revision"
        ]
      }
    },
    "activity": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "severity": {
            "const": "info"
          },
          "tone": {
            "type": "string",
            "enum": [
              "info",
              "success"
            ]
          },
          "category": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "actionLabel": {
            "type": "string"
          },
          "occurredAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "count": {
            "type": "number"
          },
          "revision": {
            "type": "string"
          },
          "retryText": {
            "type": "string"
          },
          "resolution": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "activityWindowDays": {
      "const": 14
    },
    "activityLimit": {
      "const": 50
    }
  },
  "additionalProperties": true,
  "required": [
    "workspaceId",
    "developerId",
    "checkedAt",
    "unavailable",
    "notices"
  ]
}

Documented failures: 400, 401, 403, 500, 503.

Check the workspace, not only the sign-in

GET /api/auth/me normally returns account identity. Add developerWorkspace=1 to request read-only workspace discovery. The optional developerWorkspace object distinguishes active access, an eligible first-time setup and an unavailable workspace. This request does not create a workspace, accept an invitation or grant permissions.

With available:true and initializationRequired:false, use access for the selected workspace identity, role, permissions and product scope. With available:true and initializationRequired:true, an eligible new developer still needs the existing authenticated setup to initialize their own workspace; access is not returned yet. With available:false, inspect reason instead of treating the result as an expired password or failed connection.

The supported unavailable reasons are developer_workspace_access_required, developer_workspace_not_found and developer_team_membership_inactive. ownerPortalAvailable describes access to the separate platform-owner portal; it does not grant a developer workspace. An invited account can have an ordinary customer role and still have active team access. Every later API request rechecks current membership, permissions and product scope.

SoundSync

Supported dashboard compatibility paths

GET /api/dashboard/command-center

/api/developer/dashboard/command-center

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
Request fields
  • query range: string
  • query currency: value
  • query environment: value
Returns
HTTP 200: range, period_start, period_end, currency, environment, partial, fallback_reason, access, kpis, customer_snapshot, customerSnapshot, current_month_charges, revenue_breakdown, revenue_snapshot, revenueSnapshot, business_health, businessHealth, attention, action_center, actionCenter, recent_activity, activity_feed, activityFeed, products, product_health, productHealth, integrations, goals, marketplace, developer_health_score, developerHealthScore, opportunities, backend_gaps.
Notes
First-party dashboard contract. customers.view gates private customer snapshots; billing.view gates billing state and current-month charges; settlements.view gates balances; partners.view gates reseller health. Private order/refund activity follows orders.view/refunds.view. Restricted sections are unavailable, not zero activity. Request query/body data cannot add permissions. A partial response means heavy aggregates timed out or failed, not verified zero sales. Readiness and supported reporting paths can initialize supporting records; do not use this as a zero-write public uptime probe. Package labels reflect recorded JUCE/HISE generation or remain framework-neutral. No HISE package is required for a JUCE product; saved credentials, generated packages and successful connection proof are distinct.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "currency",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "usd",
        "USD"
      ]
    }
  },
  {
    "name": "environment",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "test",
        "live"
      ]
    }
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string"
    },
    "period_start": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "period_end": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "currency": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    },
    "partial": {
      "type": "boolean"
    },
    "fallback_reason": {
      "type": "string"
    },
    "access": {
      "type": "object",
      "properties": {
        "customers": {
          "type": "boolean"
        },
        "billing": {
          "type": "boolean"
        },
        "settlements": {
          "type": "boolean"
        },
        "orders": {
          "type": "boolean"
        },
        "refunds": {
          "type": "boolean"
        },
        "marketing": {
          "type": "boolean"
        },
        "partners": {
          "type": "boolean"
        },
        "manageGoals": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "kpis": {
      "type": "object",
      "properties": {
        "revenue": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "sales": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "subscriptions": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "customers": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "products": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "downloads": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "activations": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "external_redemptions": {
          "type": "object",
          "properties": {
            "value": {
              "type": [
                "number",
                "null"
              ]
            },
            "available": {
              "type": "boolean"
            },
            "source": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "customer_snapshot": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "new_this_month": {
              "type": "integer"
            },
            "returning_percentage": {
              "type": "number"
            },
            "countries_count": {
              "type": "integer"
            },
            "top_country": {
              "type": "string"
            },
            "top_country_percentage": {
              "type": "number"
            },
            "recent_customers": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "country": {
                    "type": "string"
                  },
                  "occurred_at": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "customerSnapshot": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "new_this_month": {
              "type": "integer"
            },
            "returning_percentage": {
              "type": "number"
            },
            "countries_count": {
              "type": "integer"
            },
            "top_country": {
              "type": "string"
            },
            "top_country_percentage": {
              "type": "number"
            },
            "recent_customers": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "country": {
                    "type": "string"
                  },
                  "occurred_at": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "current_month_charges": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "marketing_email_charges_cents": {
              "type": "integer"
            },
            "redemption_overage_charges_cents": {
              "type": "integer"
            },
            "minimum_adjustment_cents": {
              "type": "integer"
            },
            "current_total_if_billed_today_cents": {
              "type": "integer"
            },
            "pre_minimum_total_cents": {
              "type": "integer"
            },
            "line_items": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
              }
            },
            "lineItems": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
              }
            },
            "marketing_emails": {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            },
            "external_redemptions": {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "properties": {
            "available": {
              "const": false
            },
            "restricted": {
              "const": true
            },
            "requiredPermission": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "restricted",
            "requiredPermission"
          ],
          "additionalProperties": true
        }
      ]
    },
    "revenue_breakdown": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "revenue_snapshot": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "revenueSnapshot": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "business_health": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessHealth": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "attention": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "action_center": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "actionCenter": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "recent_activity": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "activity_feed": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "activityFeed": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "product_health": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "productHealth": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "integrations": {
      "type": "object",
      "properties": {
        "rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "href": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "last_plugin_connection": {
          "type": [
            "object",
            "null"
          ]
        }
      },
      "additionalProperties": true
    },
    "goals": {
      "type": "object",
      "properties": {
        "month": {
          "type": "string"
        },
        "revenue_goal_cents": {
          "type": "integer"
        },
        "downloads_goal": {
          "type": "integer"
        },
        "customer_goal": {
          "type": "integer"
        },
        "products_goal": {
          "type": "integer"
        },
        "persisted": {
          "type": "boolean"
        },
        "canManage": {
          "type": "boolean"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "current": {
                "type": "number"
              },
              "target": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "percentage": {
                "type": "number"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "marketplace": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "developer_health_score": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "developerHealthScore": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "opportunities": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "backend_gaps": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.

GET /api/dashboard/launch-center

/api/developer/dashboard/launch-center

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope. Sensitive sections require their own matching permission.
Request fields
  • query range: string
  • query currency: value
  • query environment: value
Returns
HTTP 200: developer_id, generated_at, goLiveReady, completionPercent, status, blockingCount, warningCount, readiness, nextAction, checklist, issues, summaryCards, counts, health, commandCenter.
Notes
First-party dashboard contract. customers.view gates private customer snapshots; billing.view gates billing state and current-month charges; settlements.view gates balances; partners.view gates reseller health. Private order/refund activity follows orders.view/refunds.view. Restricted sections are unavailable, not zero activity. Request query/body data cannot add permissions. A partial response means heavy aggregates timed out or failed, not verified zero sales. Readiness and supported reporting paths can initialize supporting records; do not use this as a zero-write public uptime probe. Package labels reflect recorded JUCE/HISE generation or remain framework-neutral. No HISE package is required for a JUCE product; saved credentials, generated packages and successful connection proof are distinct.
Request, response and error reference

Query and header parameters

[
  {
    "name": "range",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "currency",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "usd",
        "USD"
      ]
    }
  },
  {
    "name": "environment",
    "in": "query",
    "required": false,
    "schema": {
      "enum": [
        "test",
        "live"
      ]
    }
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "developer_id": {
      "type": "integer",
      "minimum": 1
    },
    "generated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "goLiveReady": {
      "type": "boolean"
    },
    "completionPercent": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "blockingCount": {
      "type": "integer"
    },
    "warningCount": {
      "type": "integer"
    },
    "readiness": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "nextAction": {
      "type": [
        "object",
        "null"
      ]
    },
    "checklist": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "issues": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "summaryCards": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
      }
    },
    "counts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "health": {
      "type": "object",
      "properties": {
        "products": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "storefront": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "marketplace": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "billing": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "accountStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "currentInvoiceStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "pastDue": {
                  "type": "boolean"
                },
                "amountDueCents": {
                  "type": "integer"
                },
                "failedAmountCents": {
                  "type": "integer"
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "settlement": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "accountStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "payoutHold": {
                  "type": "boolean"
                },
                "availableBalanceCents": {
                  "type": "integer"
                },
                "pendingBalanceCents": {
                  "type": "integer"
                },
                "payoutMethodStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "reseller": {
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": true,
              "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "expansion": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        }
      },
      "additionalProperties": true
    },
    "commandCenter": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "period_start": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "period_end": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "currency": {
          "type": "string"
        },
        "environment": {
          "type": "string"
        },
        "partial": {
          "type": "boolean"
        },
        "fallback_reason": {
          "type": "string"
        },
        "access": {
          "type": "object",
          "properties": {
            "customers": {
              "type": "boolean"
            },
            "billing": {
              "type": "boolean"
            },
            "settlements": {
              "type": "boolean"
            },
            "orders": {
              "type": "boolean"
            },
            "refunds": {
              "type": "boolean"
            },
            "marketing": {
              "type": "boolean"
            },
            "partners": {
              "type": "boolean"
            },
            "manageGoals": {
              "type": "boolean"
            }
          },
          "additionalProperties": true
        },
        "kpis": {
          "type": "object",
          "properties": {
            "revenue": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "sales": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "subscriptions": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "customers": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "products": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "downloads": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "activations": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "external_redemptions": {
              "type": "object",
              "properties": {
                "value": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "available": {
                  "type": "boolean"
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "customer_snapshot": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "new_this_month": {
                  "type": "integer"
                },
                "returning_percentage": {
                  "type": "number"
                },
                "countries_count": {
                  "type": "integer"
                },
                "top_country": {
                  "type": "string"
                },
                "top_country_percentage": {
                  "type": "number"
                },
                "recent_customers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "name": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "format": "email"
                      },
                      "country": {
                        "type": "string"
                      },
                      "occurred_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "href": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "customerSnapshot": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "new_this_month": {
                  "type": "integer"
                },
                "returning_percentage": {
                  "type": "number"
                },
                "countries_count": {
                  "type": "integer"
                },
                "top_country": {
                  "type": "string"
                },
                "top_country_percentage": {
                  "type": "number"
                },
                "recent_customers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "name": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string",
                        "format": "email"
                      },
                      "country": {
                        "type": "string"
                      },
                      "occurred_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "href": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "current_month_charges": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "available": {
                  "type": "boolean"
                },
                "marketing_email_charges_cents": {
                  "type": "integer"
                },
                "redemption_overage_charges_cents": {
                  "type": "integer"
                },
                "minimum_adjustment_cents": {
                  "type": "integer"
                },
                "current_total_if_billed_today_cents": {
                  "type": "integer"
                },
                "pre_minimum_total_cents": {
                  "type": "integer"
                },
                "line_items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                  }
                },
                "lineItems": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                  }
                },
                "marketing_emails": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                },
                "external_redemptions": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "available": {
                  "const": false
                },
                "restricted": {
                  "const": true
                },
                "requiredPermission": {
                  "type": "string"
                }
              },
              "required": [
                "available",
                "restricted",
                "requiredPermission"
              ],
              "additionalProperties": true
            }
          ]
        },
        "revenue_breakdown": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "revenue_snapshot": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "revenueSnapshot": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "business_health": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "businessHealth": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "attention": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "action_center": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "actionCenter": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "recent_activity": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "activity_feed": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "activityFeed": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "products": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "product_health": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "productHealth": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "integrations": {
          "type": "object",
          "properties": {
            "rows": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "href": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "last_plugin_connection": {
              "type": [
                "object",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "goals": {
          "type": "object",
          "properties": {
            "month": {
              "type": "string"
            },
            "revenue_goal_cents": {
              "type": "integer"
            },
            "downloads_goal": {
              "type": "integer"
            },
            "customer_goal": {
              "type": "integer"
            },
            "products_goal": {
              "type": "integer"
            },
            "persisted": {
              "type": "boolean"
            },
            "canManage": {
              "type": "boolean"
            },
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "current": {
                    "type": "number"
                  },
                  "target": {
                    "type": "number"
                  },
                  "unit": {
                    "type": "string"
                  },
                  "percentage": {
                    "type": "number"
                  }
                },
                "additionalProperties": true
              }
            }
          },
          "additionalProperties": true
        },
        "marketplace": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "developer_health_score": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "developerHealthScore": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "opportunities": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          }
        },
        "backend_gaps": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.

GET /api/dashboard/goals

/api/developer/dashboard/goals

Auth
Account Bearer session token
Scope
analytics.view and all-products workspace scope.
Returns
HTTP 200: month, revenue_goal_cents, downloads_goal, customer_goal, products_goal, persisted, canManage, items.
Notes
Returns the current monthly goals or a default empty goal configuration. Reading goals is not authorization to change them.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string"
    },
    "revenue_goal_cents": {
      "type": "integer"
    },
    "downloads_goal": {
      "type": "integer"
    },
    "customer_goal": {
      "type": "integer"
    },
    "products_goal": {
      "type": "integer"
    },
    "persisted": {
      "type": "boolean"
    },
    "canManage": {
      "type": "boolean"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "current": {
            "type": "number"
          },
          "target": {
            "type": "number"
          },
          "unit": {
            "type": "string"
          },
          "percentage": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PUT /api/dashboard/goals

/api/developer/dashboard/goals

Auth
Account Bearer session token
Scope
analytics.view, settings.manage and all-products scope; current fixed roles permit owner/administrator writes.
Request fields
  • month: string
  • revenue_goal_cents: number
  • revenueGoalCents: number
  • revenue_goal: number
  • revenueGoal: number
  • downloads_goal: number
  • downloadsGoal: number
  • customer_goal: number
  • customerGoal: number
  • products_goal: number
  • productsGoal: number
Returns
HTTP 200: month, revenue_goal_cents, downloads_goal, customer_goal, products_goal, persisted, canManage, items.
Notes
Whole-goal replacement, not a sparse update: omitted targets become zero. Values are rounded and clamped to nonnegative integers; revenue_goal/revenueGoal are dollar aliases, while revenue_goal_cents/revenueGoalCents are cents. Omit month for the current America/New_York month; send a valid date such as 2026-10-01 for an explicit month. A successful write returns persisted:true. Saving a target changes no product prices, fees, payout settings or financial flags.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string",
      "format": "date"
    },
    "revenue_goal_cents": {
      "type": "number"
    },
    "revenueGoalCents": {
      "type": "number"
    },
    "revenue_goal": {
      "type": "number"
    },
    "revenueGoal": {
      "type": "number"
    },
    "downloads_goal": {
      "type": "number"
    },
    "downloadsGoal": {
      "type": "number"
    },
    "customer_goal": {
      "type": "number"
    },
    "customerGoal": {
      "type": "number"
    },
    "products_goal": {
      "type": "number"
    },
    "productsGoal": {
      "type": "number"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string"
    },
    "revenue_goal_cents": {
      "type": "integer"
    },
    "downloads_goal": {
      "type": "integer"
    },
    "customer_goal": {
      "type": "integer"
    },
    "products_goal": {
      "type": "integer"
    },
    "persisted": {
      "type": "boolean"
    },
    "canManage": {
      "type": "boolean"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "current": {
            "type": "number"
          },
          "target": {
            "type": "number"
          },
          "unit": {
            "type": "string"
          },
          "percentage": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: developer_team_permission_denied, DASHBOARD_GOALS_TABLE_MISSING.

An alias does not change access

Both mounts use the same dashboard handlers, analytics.view and all-products scope. Goal writes additionally require settings.manage. Sensitive customer, billing, settlement, order, refund and partner sections keep their existing separate permissions. Prefer /api/dashboard for new clients; the compatibility mount is active, not a retired route or a way around workspace restrictions.

SoundSync

Read notices without loading the dashboard

Developer Notices

The separate workspace.view notice endpoint and its narrower source checks.

Separate active issues from recent progress

The header now has Notices and Activity. Notices group actionable issues with affected items, the recorded cause, next retry and resolution guidance when available. Activity shows up to 50 grouped updates from the last 14 days, including permitted team/partner changes, successful work and milestones. Activity does not increase the warning count.

The unread warning count and activity indicator are different. Read markers stay local to this browser/account/workspace. Durable incident and milestone state is separate: marking read does not dismiss an active issue, retry a job or resolve a failed operation. A source marked unavailable is not an all-clear. Private details still depend on the teammate's existing permissions and product assignment.