Dashboards

GetTopProducts

Use this call to retrieve report about "Top ordered products" for top "10" products <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

get/api/Dashboards/GetTopProducts

Request

  • Base URL
    https://eu-ext.linnworks.net
  • URL
    https://eu-ext.linnworks.net/api/Dashboards/GetTopProducts
  • Auth
    API key in header Authorization

Query parameters

type'GroupedByQuantity' | 'GroupedByTurnover'

Used to specify type of report: 1 - group result by quantity, 2 - group result by turnover

periodinteger

Used to specify report number of months

numRowsinteger

Number of rows required

orderStatusinteger

Order status

Response

OK

RowNuminteger
Quantityinteger
Costnumber double
Titlestring
SKUstring
Currencystring

Changes

No recorded changes to this operation across all 1 revision of this API.