Request Report for Product Analytics

The Product analytics section has three mandatory call input parameters:

• Header - Authorization
• URL parameter - fileType 
• filter - a request body parameter 

Method
 

POST

3P URL

<Post Authentication Base URL>/report/product

1P URL

<Post Authentication Base URL>/report/product/v2

Headers

Authorization: Bearer <access token> (Same as described above)

URL parameters

Parameter	Type	Optional	Value	Description
fileType	string	no	CSV / XLSX	CSV is the suggested format

Body

A JSON-like object containing different filters from the table below

Mandatory Filters

Filter	Optional	Description	Example usage
"accounts"	No	Must include at least one account id. For portfolio view, please include a list	"accounts": [1234] "accounts": [1234,5678]
"startDate"	No	a value specifying the start of the requested time frame. The format is ‘yyyy-mm-dd’.	"startDate": "2023-02-21"
"endDate"	No	a value specifying the end of the requested time frame. The format is ‘yyyy-mm-dd’.	"endDate": "2023-02-21" endDate should NOT be the Current Date, the max value can be Yesterday's date  e.g (current_date - 1 day)
"comparisonType"	no	The period of the compared data	"comparisonType": "PERIOD" "comparisonType": "YEAR"
"is1p"	no	Relevant for Vendor accounts	"true"

Optional Filters

A detailed explanation of all optional filters can be found in the next section of this article.

Example response

{

    "requestId":<requestId>

}

 Optional Filters with detailed explanation

This API section's optional filters have two important components that make the reports generated via API as close as possible output-wise to the Products tab on the dashboard.

• CURRENT / HISTORICAL nested state filter
  • CURRENT - This filter will lead to an output that will be populated based only on the latest value of configuration stored in the database for the Latest date available (usually, 'yesterday's' value)
  • HISTORICAL - This filter will lead to an output that will include records based on historical values. e.g applying this filter to the Repricing Status filter with a value of "True" will lead to getting ALL items that match the condition of "Repricing was enabled at least once for the filtered period"
• String-Related filtering - EQUALS / NOT_EQUALS / CONTAINS / NOT_CONTAINS / BEGINS / ENDS
• Numerical filtering - EQUALS / NOT_EQUALS / GT (greater than) / LT (less than) / GTE (greater than or equal) / LTE (less than or equal)
• Some filters are always displayed/exported based on the Latest date available (usually, 'yesterday's' value):
  • Fulfillable Quantity
  • Reserved Quantity 
  • Inbound Quantity
  • Inventory Value = SUM(Fulfillable Quantity+Reserved Quantity+Inbound Quantity) * Inventory Cost

Filter	Description	Acceptable State Values	Example usage
repricingStatus	Specifies the repricing status of the item (true/false).	flag: true / false state: HISTORICAL / CURRENT	"repricingStatus": {"flag": true, "state": "CURRENT"} "repricingStatus": {"flag": true, "state": "HISTORICAL"}
advertisingOptimized	Specifies the ‘Advertising is optimized’ status of the item (true/false).	flag: true / false state: HISTORICAL / CURRENT	"advertisingOptimized": {"flag": true, "state": "CURRENT"} "advertisingOptimized": {"flag": true, "state": "HISTORICAL"}
advertisingStatus	Specifies the advertising status of the item.	status: ON / OFF state: HISTORICAL / CURRENT	"advertisingStatus": {"status": "ON", "state": "CURRENT"}
repricingMethod	Specifies the repricing method of the item.	method: Fixed / BuyBox / ProductSphere / Velocity state: HISTORICAL / CURRENT	"repricingMethod": {"method": "BB", "state": "HISTORICAL"}
cohort	Specifies the cohort value of the item.	value: the cohort name filter: EQUALS / NOT_EQUALS / CONTAINS / NOT_CONTAINS / BEGINS / ENDS state: HISTORICAL / CURRENT	"cohort": {"filter": {"value": "some cohort", "filter": "CONTAINS"}, "state": "HISTORICAL"} "cohort": {"filter": {"value": "some cohort", "filter": "EQUALS"}, "state": "HISTORICAL"}
inStock	Specifies whether the item is in stock or not	inStock: true / false	"inStock": true
ffc	Specifies the fulfillment method of the item	ffc: FBA / FBM	"ffc": "FBA"
searchBy	Enables filtering items by ASIN / SKU / NAME. This parameter should be inserted as a list, that way it is possible to filter by ASIN & SKU at the same time	value: the selected filter value filter: ASIN / SKU / NAME	"searchBy": [{"value": "B07XZP1B5D", "filter": "ASIN"}] "searchBy": [{"value": "B07XZP1B5D", "filter": "ASIN"},{"value": "621286", "filter": "SKU"}]
orderedUnits	Enables filtering items by the number of ordered units	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"orderedUnits": {"value": 10, "filter": "GT"} "orderedUnits": {"value": 70, "filter": "LTE"}
sales	Enables filtering items by the total sales amount	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"sales": {"value": 10, "filter": "EQUALS"} "sales": {"value": 70, "filter": "NOT_EQUALS"}
profit	Enables filtering items by profit amount	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"profit": {"value": 10, "filter": "GTE"}
profitMargin	Enables filtering items by profit Margin (%)	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"profitMargin": {"value": 12, "filter": "GTE"}
avgSalesRank	Enables filtering items by average sales rank	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"avgSalesRank": {"value": 10, "filter": "GTE"}
daysInStock	Enables filtering items by the # of days in stock throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"daysInStock": {"value": 10, "filter": "GTE"}
avgListedPrice	Enables filtering items by the average listed price throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"avgListedPrice": {"value": 10, "filter": "GTE"}
avgBuyBoxPrice	Enables filtering items by the average Buy Box price throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"avgBuyBoxPrice": {"value": 10, "filter": "GTE"}
avgBuyBoxShare	Enables filtering items by the average Buy Box Share throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"avgBuyBoxShare": {"value": 10, "filter": "GTE"}
sessions	Enables filtering items by the ASIN sessions throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"sessions": {"value": 10, "filter": "GTE"}
adSpend	Enables filtering items by the Ad Spend throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"adSpend": {"value": 10, "filter": "GTE"}
adSales	Enables filtering items by the Ad Sales throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"adSales": {"value": 10, "filter": "GTE"}
adOrderedUnits	Enables filtering items by the # of Advertising-attributed ordered units throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"adOrderedUnits": {"value": 10, "filter": "GTE"}
acos	Enables filtering items by the ACOS value throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"acos": {"value": 10, "filter": "GTE"}
roas	Enables filtering items by the ROAS value throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"roas": {"value": 10, "filter": "GTE"}
fulfillableQuantity	Enables filtering items by the Current value of the Fulfillable Quantity	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"fulfillableQuantity": {"value": 10, "filter": "EQUALS"}
reservedQuantity	Enables filtering items by the Current value of the Reserved Quantity	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"reservedQuantity": {"value": 10, "filter": "GTE"}
inboundQuantity	Enables filtering items by the Current value of the Inbound Quantity	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"inboundQuantity": {"value": 10, "filter": "LT"}
operatingMargin	Enables filtering items by the Operating Margin value throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"operatingMargin": {"value": 10, "filter": "GTE"}
velocity	Enables filtering items by the Velocity value throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"velocity": {"value": 10, "filter": "GT"}
conversionRate	Enables filtering items by the Conversion Rate value throughout the filtered period	value: the entered value filter: EQUALS / NOT_EQUALS / GT / LT / GTE / LTE	"conversionRate": {"value": -10.5, "filter": "LTE"}
vendor	Enables filtering items by the Vendor	value: the vendor name filter: EQUALS / NOT_EQUALS / CONTAINS / NOT_CONTAINS / BEGINS / ENDS	"vendor": {"value": "some vendor", "filter": "BEGINS"}
brand	Enables filtering items by the Brand	value: the brand name filter: EQUALS / NOT_EQUALS / CONTAINS / NOT_CONTAINS / BEGINS / ENDS	"brand": {"value": "Nike, "filter": "EQUALS"}

Here are a few Example Filters

• All item from store 1234, between dates 2023-02-16 and 2023-02-21, that has ACOS greater than 90 and that are currently repriced:

  {
      "accounts": [1234],
      "startDate": "2023-02-16",
      "endDate": "2023-02-21",
      "acos": {"value": 90, "filter": "GT"},
      "repricingStatus": {"flag": true, "state": "CURRENT"},
      "comparisonType": "PERIOD"
  }

• All item from stores 1234 and 5678, between dates 2023-02-16 and 2023-02-21, that has a profit less than -50.5 and buy box share less than or equal to 20:

  {
      "accounts": [1234,5678],
      "startDate": "2023-02-16",
      "endDate": "2023-02-21",
      "profit": {"value": -50.5, "filter": "LT"},
      "avgBuyBoxShare": {"value": 20, "filter": "LTE"},
      "comparisonType": "PERIOD"
  }

• All item from store 1234, between dates 2023-02-16 and 2023-02-21, that has listed price equal to 150:

  {
      "accounts": [1234],
      "startDate": "2023-02-16",
      "endDate": "2023-02-21",
      "avgListedPrice": {"value": 150, "filter": "EQUALS"},
      "comparisonType": "PERIOD"
  }