Skip to main content
GET
/
analytics
/
dashboards
/
appointments-breakdown
/
appointments-breakdown-group-summaries
Get Appointments Breakdown Group Summaries
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/appointments-breakdown/appointments-breakdown-group-summaries \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "groupKey": "<string>",
    "totalAppointments": 123,
    "uniquePatients": 123,
    "uniqueProviders": 123,
    "uniqueLocations": 123,
    "uniqueServices": 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:
service,
status,
provider,
scheduling_type,
location,
start_date,
week,
month
​
timezone
string
required

Timezone for date grouping (e.g., 'America/New_York', 'UTC')

​
sort_by
string
default:start_date
​
sort_direction
enum<string>
default:desc
Available options:
asc,
desc
​
start_date
string | null
​
end_date
string | null
​
location_ids
string[] | null
​
location_names
string[] | null
​
provider_ids
string[] | null
​
patient_ids
string[] | null
​
service_ids
string[] | null
​
service_names
string[] | null
​
statuses
string[] | null
​
scheduling_types
string[] | null

Response

Successful Response

​
groupKey
string
required

The group key this summary belongs to

​
totalAppointments
integer
required

Total number of appointments in this group

​
uniquePatients
integer
required

Number of unique patients

​
uniqueProviders
integer
required

Number of unique providers

​
uniqueLocations
integer
required

Number of unique locations

​
uniqueServices
integer
required

Number of unique services