Skip to main content

Get Product Overview

GET 
/api/reporting/products/overview

Macro product dashboard for the resolved period: headline KPIs (sales volume, units sold, profit, active products), the hottest/coldest movers, a 12-month growth heatmap, and the full leaderboard. KPIs and trends are read from monthly product metric snapshots.

Authentication: Requires Bearer token (scope: reports)

Required parameters:

  • period_mode: yoy | qoq | mom | custom

When period_mode=custom, date_from and date_to (YYYY-MM-DD or m/d/Y) are both required and date_to must be on or after date_from.

Optional:

  • growth_basis: sales | units | profit | margin (default: sales) — the basis used to rank movers and the heatmap
  • min_volume: numeric — minimum sales volume before a product qualifies as a mover
  • sales_channel_id: integer — restrict the dashboard to a single sales channel
  • include_archived: boolean — include archived products (default: false)

Request​

Responses​

Successful response