Skip to main content
GET
/
analytics
/
dashboards
/
appointments-breakdown
/
appointments-breakdown-groups
Get Appointments Breakdown Groups
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/appointments-breakdown/appointments-breakdown-groups \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "key": "<string>",
    "label": "<string>",
    "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

​
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')

​
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

​
key
string
required
​
label
string
required
​
total
integer
required