List Top Products by Financial Metric
GET/api/financials/top-products
Returns the top-performing products ranked by the specified financial metric. Used for dashboard widgets and financial analysis.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (Power User access required)
Response fields per product:
- product.id, product.name, product.sku, product.image_url
- product.brand: {id, name} (when available)
- quantity_sold: Total units sold
- revenue: Total revenue generated
- costs: Total cost of goods sold
- profit: Total profit (revenue - costs)
- num_orders: Total number of orders
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.