v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Analytics - Reports

Save the report filter

put/v2/user/analytics/{storeId}/reports/filters/{reportFilterId}

Path parameters

storeIdstring guid required

Your store identifier

reportFilterIdstring guid required

Your report filter identifier

Request body

reportFilterNamestring required

Report filter name

Example request

{
  "reportFilterName": "My report filter",
  "parameters": {
    "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"
      }
    },
    "reportType": "ByProduct",
    "productColumnsToDisplay": [
      "4b460e31-3d1f-4117-922d-b159a64ec1d2"
    ],
    "productState": "All",
    "analyticsProductColumnFilters": {
      "sku": "M1234",
      "title": "Refrigérateur"
    }
  }
}

Response

Report filter saved