provider
dashboard

Get Payments Over Time

Get charges over time grouped by charge status and week. Week label reflects the actual applicable week range (e.g., "2024-04-08 to 2024-04-14").

get/dashboard/over-time

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

weekLabelstring required
chargeStatusstring required
totalAmountnumber required
countinteger required

Changes

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