provider
analytics
analytics
Get Payment Breakdown Groups
Get payment breakdown groups with totals for the GroupedTableOrchestrator.
Returns distinct group keys with their total counts for efficient grouping.
get/analytics/dashboards/payment-breakdown/payment-breakdown-groups
Query parameters
group_by'location' | 'provider' | 'payment_medium' | 'created_date' | 'week' | 'month' required
timezonestring required
Timezone for date grouping (e.g., 'America/New_York', 'UTC')
Timezone for date grouping (e.g., 'America/New_York', 'UTC')
start_datestring nullable
end_datestring nullable
location_idsstring[] nullable
location_namesstring[] nullable
payment_mediumsstring[] nullable
payment_statusesstring[] nullable
min_amountnumber nullable
max_amountnumber nullable
commentstring 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.