Get Product Leaderboard
GET/api/reporting/products/leaderboard
Server-paginated, sortable product leaderboard for the resolved period — used when the macro dashboard's leaderboard table changes page or sort. Returns the standard Laravel pagination envelope.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope: reports)
Accepts the same period parameters as Get Product Overview, plus:
- sort: column to sort by, prefix with - for descending
- page / per_page: standard pagination controls (per_page default 25)
Request
Responses
- 200
- 401
- 403
- 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.
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.