BizKitHub Developer Documentation

Parameters

1 query

Query parameters

· 1

daysnumberOptional

Number of days ahead to analyze. Defaults to 14.

Default: 14

Example14

Response schema

1 status code documented

200SuccessCalendar utilization metrics.

overallUtilizationnumberRequired

Overall utilization rate (0-100%).

totalSlotsnumberRequired

Total number of events/slots in the period.

bookedSlotsnumberRequired

Number of active (non-cancelled) bookings.

cancelledEventsnumberRequired

Number of cancelled events in the period.

cancellationRatenumberRequired

Cancellation rate (0-100%).

byCalendarobject[]Required

Utilization breakdown by calendar.

Each array item:

Calendar utilization item.

calendarIdnumberRequired

Calendar ID.

calendarNamestringRequired

Calendar name.

utilizationnumberRequired

Utilization rate for this calendar (0-100%).

bookedHoursnumberRequired

Total booked hours.

availableHoursnumberRequired

Total available hours (estimated).

dailyUtilizationobject[]Required

Daily utilization trend for charting.

Each array item:

Daily utilization data point.

datestringRequired

Date (YYYY-MM-DD).

utilizationnumberRequired

Utilization for this day (0-100%).

bookedEventsnumberRequired

Number of booked events on this day.

Response example

application/json

{
  "overallUtilization": 0,
  "totalSlots": 0,
  "bookedSlots": 0,
  "cancelledEvents": 0,
  "cancellationRate": 0,
  "byCalendar": [
    {
      "calendarId": 0,
      "calendarName": "example_calendarName",
      "utilization": 0,
      "bookedHours": 0,
      "availableHours": 0
    }
  ],
  "dailyUtilization": [
    {
      "date": "example_date",
      "utilization": 0,
      "bookedEvents": 0
    }
  ]
}

/bff/dashboard/calendar-utilization