Skip to main content
GET
/
analytics
/
dashboards
/
provider-earnings
/
provider-earnings-group-summaries
Get Provider Earnings Group Summaries
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/provider-earnings/provider-earnings-group-summaries \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "groupKey": "<string>",
    "totalSold": 123,
    "totalDiscounts": 123,
    "totalTips": 123,
    "totalVoidAdjustments": 123,
    "totalTaxes": 123,
    "totalOutstandingBalances": 123,
    "totalRefunds": 123,
    "totalEarnings": 123,
    "uniquePatients": 123,
    "uniqueLocations": 123
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
group_by
enum<string>
required
Available options:
location,
date
​
timezone
string
required
​
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

​
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