Admin Reporting: Products

Reporting — products

Changed on

Product reporting stats. ?type= picks the stat group.

get/reporting/products

Request

Query parameters

type'total-sold-quantities' | 'total-products-added-to-wishlist' | 'top-selling-products-by-revenue' | 'top-selling-products-by-quantity' | 'products-with-most-reviews' | 'last-search-terms' | 'top-search-terms'

Stat group.

startstring date

Start date.

endstring date

End date.

channelstring

Channel code.

Response

AdminReportingProducts collection

entitystring nullable
typestring nullable
statisticsobject nullable

Example response

[
  {
    "statistics": {
      "quantities": {
        "previous": 82,
        "current": 13,
        "progress": -84.15
      },
      "over_time": {
        "previous": [
          {
            "label": "10 Apr",
            "total": 21
          }
        ],
        "current": [
          {
            "label": "10 May",
            "total": 5
          }
        ]
      }
    }
  }
]

Changes