provider
dashboard
Get Payment Overview
Get an overview of payments including total revenue from POS, top-selling items, and top customers by spending.
get/dashboard/overview
Query parameters
pageinteger nullable
per_pageinteger nullable
sort_bystring nullable
sort_direction'asc' | 'desc' nullable
location_idstring nullable
start_datestring required
end_datestring required
location_idsstring[] nullable
payment_mediumsstring[] nullable
tzstring required
limitinteger nullable
Headers
TENANTstring required
The tenant you are making this request on behalf of
API-KEYstring required
Your api key
Response
Successful Response
Changes
No recorded changes to this endpoint across all 1 revision of this API.