Skip to main content
GET
/
analytics
/
dashboards
/
provider-earnings
/
provider-earnings
Get Provider Earnings
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/provider-earnings/provider-earnings \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "provider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "totalSold": 123,
      "discounts": 123,
      "tips": 123,
      "voidAdjustments": 123,
      "taxes": 123,
      "outstandingBalances": 123,
      "refunds": 123,
      "totalEarnings": 123,
      "uniquePatients": 123,
      "uniqueLocations": 123
    }
  ],
  "total": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100
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
timezone
string
required
location
string | null
date
string | null
created_date
string | null

Response

Successful Response

data
ProviderEarningsItem · object[]
required
total
integer
required