Get Overview
GET/v1/overview
Read sales-performance totals, trends, and product context for an optional brand and date scope. Omitted brandIds use the caller's accessible brands.
Requires salesPerformance.read.
Request and response fields at a glance
- Query parameters:
brandIds(array),startDate(string),endDate(string),excludeSaleChannelIds(array),productTiers(array),categories(array). - 200 response (application/json):
newOrdersCount(number, required),packedOrdersCount(number, required),shippedOrdersCount(number, required),totalOrdersCount(number, required),activeProducts(number, required),todaysOrdersCount(number, required),todaysRevenue(number, required),increaseFromYesterday(number, required),totalRevenue(number, required),previousPeriodRevenue(number, required),revenueGrowth(number, required),aov(number, required),totalUnitsSold(number, required),brands(array, required),saleChannels(array, required),revenueTrend(array, required),aggregatedRevenueTrend(array, required),stockAlerts(object, required),topPerformers(array, required),revenueSharePerChannel(array, required),revenueSharePerBrand(array, required),revenueSharePerBrandPerChannel(array, required),revenueSharePerCategory(array, required),revenueSharePerCategoryPerChannel(array, required).