v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB

Analytics - Reports

Get the report filter description

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

Path parameters

storeIdstring guid required

Your store identifier

reportFilterIdstring guid required

Your report filter identifier

Response

Report filter

reportFilterIdstring guid required

Report filter identifier

reportFilterNamestring required

Report filter name

Example response

{
  "reportFilterId": "fb19c53c-2f63-4262-9d94-2d7faa500acd",
  "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"
    }
  },
  "links": {
    "self": {
      "href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/reports/filters/fb19c53c-2f63-4262-9d94-2d7faa500acd",
      "method": "GET"
    },
    "save": {
      "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/reports/filters/{reportFilterId}",
      "method": "PUT",
      "templated": "true",
      "parameters": [
        {
          "name": "reportFilterId",
          "type": "string",
          "in": "path"
        }
      ]
    },
    "delete": {
      "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/reports/filters/fb19c53c-2f63-4262-9d94-2d7faa500acd",
      "method": "DELETE"
    }
  }
}