Docs API Reference Calendar Analytics/bff/calendar/calendar-analytics-peak-hours-heatmap

/bff/calendar/calendar-analytics-peak-hours-heatmap

Shows when the calendar is most busy by day and hour - critical for pricing, capacity planning, and staffing decisions. Returns a matrix of day×hour with event counts.

Calendar AnalyticsgetBffCalendarCalendar-analytics-peak-hours-heatmap

Parameters

1 query

Query parameters

· 1

codestringRequired

Calendar code identifier.

Exampleexample_code

Response schema

1 status code documented

200Success

dataobject[]Required

Each array item:

dayOfWeeknumberRequired

Day of week (0=Sunday, 6=Saturday).

hourOfDaynumberRequired

Hour of day (0-23).

eventCountnumberRequired

Number of events in this slot.

maxCountnumberRequired

Maximum event count in any slot.

Response example

application/json

{
  "data": [
    {
      "dayOfWeek": 0,
      "hourOfDay": 0,
      "eventCount": 0
    }
  ],
  "maxCount": 0
}

Request example

GET /bff/calendar/calendar-analytics-peak-hours-heatmap

get

curl -X GET "https://api.bizkithub.com/bff/calendar/calendar-analytics-peak-hours-heatmap?code=example_code" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key