---
title: "Get Provider Earnings Groups"
method: GET
path: "/analytics/dashboards/provider-earnings/provider-earnings-groups"
tags: ["provider", "analytics"]
---

# Get Provider Earnings Groups

`GET /analytics/dashboards/provider-earnings/provider-earnings-groups`

## 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-groups`
- Auth: none declared. Required headers: `TENANT`, `API-KEY`
- TypeScript: <https://skmtc.dev/decodahealth/apis/decoda-api/docs/analytics/dashboards/provider-earnings/provider-earnings-groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Get available groups for provider earnings data

## Query parameters

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

## Headers

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

## Response `200`

Successful Response

- DecodaAppsApiRoutesAnalyticsDashboardsProviderEarningsGroupItem[]
  - `key` string, required
  - `label` string, required
  - `total` integer, nullable

## 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)