Parameters
2 query
Query parameters
· 2daysnumberOptionalNumber of days to analyze. Defaults to 30.
Default:
30Example
30limitnumberOptionalNumber of products to return. Defaults to 10.
Default:
10Example
10/bff/dashboard/top-products
Returns best-selling products by revenue and quantity. Identifies what generates revenue vs marketing noise.
DashboardgetBffDashboardTop-products
Response schema
1 status code documented
200SuccessTop products analysis.
productsobject[]RequiredTop products sorted by revenue (highest first).
Each array item:
Top product item.
ranknumberRequiredRank by revenue (1 = highest revenue).
productIdnumberOptionalInternal product ID. Undefined for ad-hoc items.
productCodestringOptionalProduct code. Undefined for ad-hoc items.
productNamestringRequiredProduct name or order item label.
quantitySoldnumberRequiredTotal quantity sold.
revenuenumberRequiredTotal revenue generated.
orderCountnumberRequiredNumber of orders containing this product.
averagePricenumberRequiredAverage selling price per unit.
revenuePercentagenumberRequiredPercentage of total revenue (0-100).
totalRevenuenumberRequiredTotal revenue for the period (for percentage calculation).
currencystringRequiredCurrency code for all amounts (e.g., "CZK").
Response example
application/json{
"products": [
{
"rank": 0,
"productId": 0,
"productCode": "example_productCode",
"productName": "example_productName",
"quantitySold": 0,
"revenue": 0,
"orderCount": 0,
"averagePrice": 0,
"revenuePercentage": 0
}
],
"totalRevenue": 0,
"currency": "example_currency"
}Request example
GET /bff/dashboard/top-products
curl -X GET "https://api.bizkithub.com/bff/dashboard/top-products?days=30&limit=10" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"Need an API key?
All BizKitHub public API endpoints require authentication via API key.