Get Product Scorecard
GET/api/reporting/products/:product/scorecard
Standalone computed scorecard for one product — the composite, its band and the per-dimension breakdown. Used by the Scorecard Settings live preview.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope: reports)
Path parameter:
- product: the product ID
Accepts the same period parameters as Get Product Overview. When the optional preview_weights, preview_thresholds and preview_min_so_count parameters are supplied together, the score is computed against a transient, non-persisted settings configuration built from those values — nothing is written to the scorecard settings table. Supplying any one of the three without the others returns a 422.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.