---
title: "Get Provider Earnings Group Summaries"
method: GET
path: "/analytics/dashboards/provider-earnings/provider-earnings-group-summaries"
tags: ["provider", "analytics"]
---

# Get Provider Earnings Group Summaries

`GET /analytics/dashboards/provider-earnings/provider-earnings-group-summaries`

## Request

- Base URL: `https://docs.decodahealth.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.decodahealth.com/analytics/dashboards/provider-earnings/provider-earnings-group-summaries`
- Auth: none declared. Required headers: `TENANT`, `API-KEY`
- TypeScript: <https://skmtc.dev/decodahealth/apis/decoda-api/docs/analytics/dashboards/provider-earnings/provider-earnings-group-summaries/get.ts> (a function with typed inputs; its response is checked against the schema)

Get summary data for each group

## Query parameters

- `group_by` 'location' | 'date', required
- `timezone` string, required
- `start_date` string, date, nullable
- `end_date` string, date, nullable
- `location_ids` string[], nullable
- `provider_ids` string[], nullable
- `provider_names` string[], nullable
- `min_earnings` integer, nullable
- `max_earnings` integer, nullable

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- DecodaAppsApiRoutesAnalyticsDashboardsProviderEarningsGroupSummary[]
  - `groupKey` string, required
  - `totalSold` integer, required
  - `totalDiscounts` integer, required
  - `totalTips` integer, required
  - `totalVoidAdjustments` integer, required
  - `totalTaxes` integer, required
  - `totalOutstandingBalances` integer, required
  - `totalRefunds` integer, required
  - `totalEarnings` integer, required
  - `uniquePatients` integer, required
  - `uniqueLocations` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)