Docs API Reference Calendar Analytics/bff/calendar/calendar-analytics-report

/bff/calendar/calendar-analytics-report

Returns the default calendar analytics report with hourly usage patterns. Use the specific analytics endpoints for detailed metrics.

Calendar AnalyticsgetBffCalendarCalendar-analytics-report

Parameters

1 query

Query parameters

· 1

codestringRequired

Calendar code identifier.

Exampleexample_code

Response schema

1 status code documented

200Success

timezonestringRequired

Calendar timezone.

hourUsagesobject[]Required

Event count aggregated by hour of day.

Each array item:

hourOfDaynumberRequired

Hour of day (0-23).

eventCountnumberRequired

Number of events in this hour.

hourDayUsagesobject[]Required

Event count aggregated by hour and day of week (heatmap data).

Each array item:

hourOfDaynumberRequired

Hour of day (0-23).

dayOfWeeknumberOptional

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

eventCountnumberRequired

Number of events.

Response example

application/json

{
  "timezone": "example_timezone",
  "hourUsages": [
    {
      "hourOfDay": 0,
      "eventCount": 0
    }
  ],
  "hourDayUsages": [
    {
      "hourOfDay": 0,
      "dayOfWeek": 0,
      "eventCount": 0
    }
  ]
}

Request example

GET /bff/calendar/calendar-analytics-report

get

curl -X GET "https://api.bizkithub.com/bff/calendar/calendar-analytics-report?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