Sign in

v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Analytics - Statistics

Get the report by product

Get the report by product

post/v2/user/analytics/{storeId}/reports/byproduct

Path parameters

storeIdstring guid required

Your store identifier

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

pageSizeinteger

Indicate the item count per page

pageNumberinteger

Indicates the page number

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

You can filter on the product state.

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

Response

Your reporting by product

currencyCodestring required

The currency code <a href="https://en.wikipedia.org/wiki/ISO_4217">(ISO 4217)</a>

Example response

{
  "paginationResult": {
    "entryCount": "25",
    "pageCount": "38",
    "totalEntryCount": "943",
    "links": {
      "first": {
        "href": "/v2/user/marketplaces/orders/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "1"
            }
          }
        ]
      },
      "last": {
        "href": "/v2/user/marketplaces/orders/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "38"
            }
          }
        ]
      },
      "next": {
        "href": "/v2/user/marketplaces/orders/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "2"
            }
          }
        ]
      }
    }
  },
  "currencyCode": "EUR",
  "products": [
    {
      "product": {
        "productId": "00000000-0000-0000-0000-000000000000",
        "productSku": "SKU1234",
        "productTitle": "My supert product",
        "productImageUrl": "http://i2.cdscdn.com/pdt2/3/9/0/1/550x550/hai6901018043390/rw/haier-b20fwrss-refrigerateur-americain.jpg"
      },
      "links": {
        "oneChannelLinks": {
          "productInfo": {
            "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products/578419df-1bbf-41a6-96fa-862e42182b67",
            "method": "GET"
          },
          "enableProductForOneChannel": {
            "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/byProduct/6d469a54-8426-4855-abc2-9e062e2056b9/enable",
            "method": "POST",
            "parameters": {
              "request": {
                "in": "body",
                "type": "​array",
                "value": [
                  "a2d38563-50f0-43f1-be2b-b16e7ec4f007"
                ]
              }
            }
          },
          "disableProductForOneChannel": {
            "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/byProduct/6d469a54-8426-4855-abc2-9e062e2056b9/enable",
            "method": "POST",
            "parameters": {
              "request": {
                "in": "body",
                "type": "​array",
                "value": [
                  "a2d38563-50f0-43f1-be2b-b16e7ec4f007"
                ]
              }
            }
          }
        },
        "allChannelsLinks": {
          "enableProductForAllChannels": {
            "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/byProduct/6d469a54-8426-4855-abc2-9e062e2056b9/enable",
            "method": "POST",
            "parameters": {
              "request": {
                "in": "body",
                "type": "​array",
                "value": [
                  "a2d38563-50f0-43f1-be2b-b16e7ec4f007"
                ]
              }
            }
          },
          "disableProductForAllChannels": {
            "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/byProduct/6d469a54-8426-4855-abc2-9e062e2056b9/enable",
            "method": "POST",
            "parameters": {
              "request": {
                "in": "body",
                "type": "​array",
                "value": [
                  "a2d38563-50f0-43f1-be2b-b16e7ec4f007"
                ]
              }
            }
          }
        }
      }
    }
  ],
  "links": {
    "enableAllProducts": {
      "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/all/enable",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "type": "object",
          "schema": "optimiseAllRequest",
          "value": {
            "channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
            "beginPeriodUtcDate": "2006-11-20T00:00:00Z",
            "endPeriodUtcDate": "2006-12-20T00:00:00Z",
            "categoryFilter": {
              "categoryPath": [
                "Home",
                "Bedroom"
              ]
            },
            "performanceIndicatorFilters": [
              {
                "performanceIndicator": "Cost",
                "operatorName": "Equals",
                "value": "10"
              }
            ],
            "advancedFilters": {
              "marginType": "Global",
              "globalmarginPercent": "10",
              "linkClickToOrderType": "OnClickDate",
              "linkClickToOrderMaxDay": "5",
              "onlyPaymentValidatedOrders": "true",
              "onlyDirectSales": "true",
              "performanceIndicatorFormula": {
                "firstParameter": "Cost",
                "operatorName": "Multiply",
                "secondParamter": "ROI",
                "thirdParameter": "100"
              }
            },
            "productState": "All",
            "analyticsProductColumnFilters": {
              "sku": "M1234",
              "title": "Refrigérateur",
              "additionalAnalyticsProductColumnFilters": [
                {
                  "columnId": "672644c7-5bd0-4e25-88c1-1f732bda5e4c",
                  "operatorName": "NumericalGreaterThan",
                  "values": [
                    "100"
                  ]
                }
              ]
            }
          }
        }
      }
    },
    "disableAllProducts": {
      "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/all/enable",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "type": "object",
          "schema": "optimiseAllRequest",
          "value": {
            "channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
            "beginPeriodUtcDate": "2006-11-20T00:00:00Z",
            "endPeriodUtcDate": "2006-12-20T00:00:00Z",
            "categoryFilter": {
              "categoryPath": [
                "Home",
                "Bedroom"
              ]
            },
            "performanceIndicatorFilters": [
              {
                "performanceIndicator": "Cost",
                "operatorName": "Equals",
                "value": "10"
              }
            ],
            "advancedFilters": {
              "marginType": "Global",
              "globalmarginPercent": "10",
              "linkClickToOrderType": "OnClickDate",
              "linkClickToOrderMaxDay": "5",
              "onlyPaymentValidatedOrders": "true",
              "onlyDirectSales": "true",
              "performanceIndicatorFormula": {
                "firstParameter": "Cost",
                "operatorName": "Multiply",
                "secondParamter": "ROI",
                "thirdParameter": "100"
              }
            },
            "productState": "All",
            "analyticsProductColumnFilters": {
              "sku": "M1234",
              "title": "Refrigérateur",
              "additionalAnalyticsProductColumnFilters": [
                {
                  "columnId": "672644c7-5bd0-4e25-88c1-1f732bda5e4c",
                  "operatorName": "NumericalGreaterThan",
                  "values": [
                    "100"
                  ]
                }
              ]
            }
          }
        }
      }
    },
    "enableProducts": {
      "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/enable",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "type": "object",
          "schema": "optimiseRequest",
          "value": {
            "channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
            "beginPeriodUtcDate": "2006-11-20T00:00:00Z",
            "endPeriodUtcDate": "2006-12-20T00:00:00Z",
            "categoryFilter": {
              "categoryPath": [
                "Home",
                "Bedroom"
              ]
            },
            "performanceIndicatorFilters": [
              {
                "performanceIndicator": "Cost",
                "operatorName": "Equals",
                "value": "10"
              }
            ],
            "advancedFilters": {
              "marginType": "Global",
              "globalmarginPercent": "10",
              "linkClickToOrderType": "OnClickDate",
              "linkClickToOrderMaxDay": "5",
              "onlyPaymentValidatedOrders": "true",
              "onlyDirectSales": "true",
              "performanceIndicatorFormula": {
                "firstParameter": "Cost",
                "operatorName": "Multiply",
                "secondParamter": "ROI",
                "thirdParameter": "100"
              }
            },
            "pageSize": "100",
            "pageNumber": "1",
            "productState": "All",
            "analyticsProductColumnFilters": {
              "sku": "M1234",
              "title": "Refrigérateur",
              "additionalAnalyticsProductColumnFilters": [
                {
                  "columnId": "672644c7-5bd0-4e25-88c1-1f732bda5e4c",
                  "operatorName": "NumericalGreaterThan",
                  "values": [
                    "100"
                  ]
                }
              ]
            }
          }
        }
      }
    },
    "disableProducts": {
      "href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/enable",
      "method": "POST",
      "parameters": {
        "request": {
          "in": "body",
          "type": "object",
          "schema": "optimiseRequest",
          "value": {
            "channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
            "beginPeriodUtcDate": "2006-11-20T00:00:00Z",
            "endPeriodUtcDate": "2006-12-20T00:00:00Z",
            "categoryFilter": {
              "categoryPath": [
                "Home",
                "Bedroom"
              ]
            },
            "performanceIndicatorFilters": [
              {
                "performanceIndicator": "Cost",
                "operatorName": "Equals",
                "value": "10"
              }
            ],
            "advancedFilters": {
              "marginType": "Global",
              "globalmarginPercent": "10",
              "linkClickToOrderType": "OnClickDate",
              "linkClickToOrderMaxDay": "5",
              "onlyPaymentValidatedOrders": "true",
              "onlyDirectSales": "true",
              "performanceIndicatorFormula": {
                "firstParameter": "Cost",
                "operatorName": "Multiply",
                "secondParamter": "ROI",
                "thirdParameter": "100"
              }
            },
            "pageSize": "100",
            "pageNumber": "1",
            "productState": "All",
            "analyticsProductColumnFilters": {
              "sku": "M1234",
              "title": "Refrigérateur",
              "additionalAnalyticsProductColumnFilters": [
                {
                  "columnId": "672644c7-5bd0-4e25-88c1-1f732bda5e4c",
                  "operatorName": "NumericalGreaterThan",
                  "values": [
                    "100"
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}