Appointment volume, completion, cancellation and no-show counts over a date range.

GEThttps://app.softsolz.uk/api/v1/services/appointments/reports/summary

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

fromstring

Start of the reporting range, ISO date.

tostring

End of the reporting range, ISO date.

Response

Response Body

rangeobjectThe range reported on. Appointments starting from "from" up to, but not including, "to". Defaults to the 30 days up to now.

totalintegerAppointments starting in the range, in any state.

completedintegerAppointments completed or closed.

cancelledintegerAppointments cancelled.

no_showintegerAppointments the customer did not attend.

upcomingintegerAppointments still scheduled or confirmed.

completion_ratenumberPercentage of finished appointments (completed, cancelled or no-show) that were completed, to one decimal place. 0 when none finished.

cancellation_ratenumberPercentage of finished appointments (completed, cancelled or no-show) that were cancelled, to one decimal place. 0 when none finished.

no_show_ratenumberPercentage of finished appointments (completed, cancelled or no-show) that were no-shows, to one decimal place. 0 when none finished.

revenue_centsintegerSum of the prices of completed appointments, in the smallest currency unit.

avg_duration_minutesnumberAverage length of completed appointments in minutes, to one decimal place.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/appointments/reports/summary \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "range": {
      "from": "2026-09-01T00:00:00.000Z",
      "to": "2026-12-31T00:00:00.000Z"
    },
    "total": 2,
    "completed": 0,
    "cancelled": 0,
    "no_show": 0,
    "upcoming": 2,
    "completion_rate": 0,
    "cancellation_rate": 0,
    "no_show_rate": 0,
    "revenue_cents": 0,
    "avg_duration_minutes": 0
  }
}