Skip to main content

Get Period Comparison

GET 
/v1/overview/period-comparison

Compare two sales periods for the caller's selected brands. All four period start/end dates are required, and the response separates their metrics and change.

Requires salesPerformance.read.

Request and response fields at a glance
  • Query parameters: p1StartDate (string), p1EndDate (string), p2StartDate (string), p2EndDate (string), brandIds (array), excludeSaleChannelIds (array), productTiers (array), categories (array).
  • 200 response (application/json): p1 (object, required), p2 (object, required), growth (object, required), decliningProducts (mixed, required), growingProducts (mixed, required), decliningCategories (array, required), growingCategories (array, required).

Request​