Skip to main content
GET
/
dashboard
/
top-selling-items
Get Top Selling Items
curl --request GET \
  --url https://api.decodahealth.com/dashboard/top-selling-items \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "itemType": "<string>",
    "price": 123,
    "totalQuantity": 123,
    "numberOfPurchases": 123,
    "totalRevenue": 123,
    "averageQuantityPerPurchase": 123,
    "description": "<string>"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
page
integer | null
default:1
​
per_page
integer | null
default:10
​
sort_by
string | null
​
sort_direction
enum<string> | null
Available options:
asc,
desc
​
location_id
string | null
​
start_date
string
required
​
end_date
string
required
​
location_ids
string[] | null
​
payment_mediums
string[] | null
​
tz
string
required
​
limit
integer | null

Response

Successful Response

​
id
string
required
​
name
string
required
​
itemType
string
required
​
price
number
required
​
totalQuantity
integer
required
​
numberOfPurchases
integer
required
​
totalRevenue
number
required
​
averageQuantityPerPurchase
number
required
​
description
string | null