Get Top Performers
GET/products/top-performers
Return top products or listings for the optional date, brand, channel, tier, and category filters. The default page is 2 because the overview supplies the first set.
With performanceBreakdown=ByParent each row is an item: a parent (one design sold in several sizes or colours), or a product with no parent. A parent row carries parentKey, parent and variants and no product; its totalRevenue, unitsSold and saleChannelBreakdown sum its variants with sales in the window. A product with no parent is a row with parentKey: null, its product, and variants holding that one product. page and limit count items.
Requires sales-performance.read.
Request and response fields at a glance
- Query parameters:
brandIds(array),startDate(string),endDate(string),excludeSaleChannelIds(array),performanceBreakdown(string),page(integer),limit(integer),productTiers(array),categories(array). - 200 response (application/json): array of
listing(object),product(object),totalRevenue(number, required),unitsSold(number, required),brandName(string, required),brandNameAR(string or null, required),saleChannelBreakdown(array),growthPercentage(number or null),p1Revenue(number),p2Revenue(number),isOutOfStock(boolean),parentKey(string or null),parent(object),variants(array).