Skip to main content
GET
/
appointment-dashboard
/
trend
Get Appointment Trend
curl --request GET \
  --url https://api.decodahealth.com/appointment-dashboard/trend \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "date": "<string>",
    "series": [
      {
        "mode": "appointment_volume",
        "locationId": "<string>",
        "locationName": "<string>",
        "scheduledCount": 123,
        "bookedCount": 123,
        "cancelledNoShowCount": 123,
        "newServicesCount": 123,
        "existingServicesCount": 123,
        "percentageOfNewServices": 123
      }
    ]
  }
]

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

start_date
string<date> | null
end_date
string<date> | null
timezone
string
required
provider_ids
string | null
location_ids
string | null
group_by
string
default:day

Group by: day, week, or month

breakdown
string
default:appointment_volume

appointment_volume | new_appointments_percentage

by_location
boolean
default:false

Break down series by location

Response

Successful Response

date
string
required
series
AppointmentTrendSeries · object[]
required