Sign in

v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Analytics - Optimisations

Optimise products by page

/!\ WARNING /!\
Apply the operation on every product related to this request.
This operation is used at the bottom of the analytics page result.

post/v2/user/analytics/{storeId}/optimisations/{actionName}

Path parameters

storeIdstring guid required

Your store identifier

actionName'reenable' | 'disable' optimisationActionName required

Request body

channelIdstring guid

The channel identifier

periodType'Custom' | 'Yesterday' | 'Last7Days' | 'LastWeek' | 'ThisMonth' | 'Last30Days' | 'LastMonth' | 'Last60Days' | 'Last90Days' | 'Last3Months' required

Indicates the period type we want use for the report filter

beginPeriodUtcDatestring date-time required

The begin date period you want to get the report. It's required only in case of custom period type !

endPeriodUtcDatestring date-time required

The end date period you want to get the report. It's required only in case of custom period type !

orderBy'ClickCount' | 'Cost' | 'OrderCount' | 'ProductCount' | 'SoldProductCount' | 'DisabledProductCount' | 'EnabledProductCount' | 'TotalSales' | 'Margin' | 'ROI' | 'PerformanceIndicator'

Indicate on which indicator or value you want to make your formula

orderByDirection'Ascending' | 'Descending'

Indicate which direction to order results by

reportType'ByChannel' | 'ByCategory' | 'ByProduct' | 'ByDay' required

The report type

productColumnsToDisplayBeezUPCommonCatalogColumnId[]
productState'All' | 'Enabled' | 'Disabled'

You can filter on the product state.

pageSizeinteger

Indicate the item count per page

pageNumberinteger

Indicates the page number

Example request

{
  "channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
  "beginPeriodUtcDate": "2006-11-20T00:00:00Z",
  "endPeriodUtcDate": "2006-12-20T00:00:00Z",
  "categoryFilter": {
    "categoryPath": [
      "Maison",
      "Chambre"
    ]
  },
  "performanceIndicatorFilters": [
    {
      "indicator": "Cost",
      "operatorName": "Equals",
      "value": "10"
    }
  ],
  "advancedFilters": {
    "marginType": "Global",
    "linkClickToOrderType": "OnClickDate",
    "performanceIndicatorFormula": {
      "firstParameter": "Cost",
      "operatorName": "Multiply",
      "secondParamter": "ROI",
      "thirdParameter": "100"
    }
  },
  "orderBy": "Cost",
  "orderByDirection": "Ascending",
  "reportType": "ByProduct",
  "productColumnsToDisplay": [
    "4b460e31-3d1f-4117-922d-b159a64ec1d2"
  ],
  "productState": "All",
  "analyticsProductColumnFilters": {
    "sku": "M1234",
    "title": "Refrigérateur"
  }
}

Response

Products optimisatized