API reference

Reports

Practice numbers for dashboards and daily summaries. Doctors' keys see their own numbers.

Today at a glance

GET/api/v1/dashboard/statsScope: reports:read

Appointments today, waiting and done, total and new patients, consultations and open drafts.

Field	Where	Type	Description
`from`	after ?	datetime	Start of the day to report on. Default today.

Example request

bash

curl "https://your-healthfix-site/api/v1/dashboard/stats" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

json

{
  "data": {
    "appointments_today": 24, "appointments_waiting": 3, "appointments_done": 15,
    "patients_total": 4210, "patients_new_30d": 186,
    "consultations_today": 15, "open_drafts": 1
  }
}

Practice report

GET/api/v1/reports/overviewScope: reports:read

Revenue, footfall, top diagnoses and doctor performance for a date range.

Field	Where	Type	Description
`from`	after ?	date	First day, YYYY-MM-DD.
`to`	after ?	date	Last day, YYYY-MM-DD.
`doctor_id`	after ?	uuid	Only this doctor.
`branch_id`	after ?	uuid	Only this branch.

Example request

bash

curl "https://your-healthfix-site/api/v1/reports/overview?from=2026-09-01&to=2026-09-30" \
  -H "Authorization: Bearer YOUR_API_KEY"