Skip to main content
GET
/
analytics
/
dashboards
/
provider-earnings
/
provider-earnings-grouped
Get Provider Earnings Grouped
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/provider-earnings/provider-earnings-grouped \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "groups": [
    {
      "key": "<string>",
      "label": "<string>",
      "count": 123,
      "summary": {
        "totalSold": 0,
        "totalDiscounts": 0,
        "totalTips": 0,
        "totalVoidAdjustments": 0,
        "totalTaxes": 0,
        "totalOutstandingBalances": 0,
        "totalRefunds": 0,
        "totalEarnings": 0,
        "totalUniquePatients": 0,
        "totalUniqueLocations": 0,
        "providerCount": 0
      },
      "rows": [
        {
          "providerId": "<string>",
          "providerFirstName": "<string>",
          "providerLastName": "<string>",
          "providerEmail": "<string>",
          "totalSold": 123,
          "discounts": 123,
          "tips": 123,
          "voidAdjustments": 123,
          "taxes": 123,
          "outstandingBalances": 123,
          "refunds": 123,
          "totalEarnings": 123,
          "uniquePatients": 123,
          "uniqueLocations": 123
        }
      ]
    }
  ],
  "grandTotals": {
    "totalSold": 0,
    "totalDiscounts": 0,
    "totalTips": 0,
    "totalVoidAdjustments": 0,
    "totalTaxes": 0,
    "totalOutstandingBalances": 0,
    "totalRefunds": 0,
    "totalEarnings": 0,
    "totalUniquePatients": 0,
    "totalUniqueLocations": 0,
    "providerCount": 0
  },
  "totalCount": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

timezone
string
required
group_by
enum<string>
default:none
Available options:
location,
date,
none
start_date
string<date> | null
end_date
string<date> | null
location_ids
string[] | null
provider_ids
string[] | null
provider_names
string[] | null
min_earnings
integer | null
max_earnings
integer | null

Response

Successful Response

Complete response from the provider earnings grouped endpoint.

groups
ProviderEarningsGroup · object[]
required
grandTotals
ProviderEarningsSummary · object
required

Aggregated summary for a group or grand totals.

totalCount
integer
required