BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/cancelled-events
getDashboardAdmin BFF

/bff/dashboard/cancelled-events

Analyzes event cancellations by calendar and day of week. For service businesses, reveals issues with pricing, capacity, or communication.

DashboardgetBffDashboardCancelled-events

Parameters

1 query

Query parameters

· 1
daysnumberOptional

Number of days to analyze. Defaults to 30.

Default: 30
Example30

Response schema

1 status code documented

200SuccessCancelled events analysis.
summaryobjectRequired
totalEventsnumberRequired

Total events.

cancelledEventsnumberRequired

Cancelled events.

cancellationRatenumberRequired

Cancellation rate (0-100%).

lostRevenuenumberRequired

Estimated lost revenue.

byCalendarobject[]Required

Cancellations by calendar.

Each array item:
calendarIdnumberRequired

Calendar ID.

calendarNamestringRequired

Calendar name.

totalEventsnumberRequired

Total events.

cancelledEventsnumberRequired

Cancelled events.

cancellationRatenumberRequired

Cancellation rate (0-100%).

byDayOfWeekobject[]Required

Cancellations by day of week.

Each array item:
dayOfWeeknumberRequired

Day of week (0=Sunday).

dayNamestringRequired

Day name.

totalEventsnumberRequired

Total events.

cancelledEventsnumberRequired

Cancelled events.

cancellationRatenumberRequired

Cancellation rate (0-100%).

recentCancellationsobject[]Required

Recent cancellations (max 20).

Each array item:
eventIdnumberRequired

Event ID.

eventTitlestringRequired

Event title.

calendarNamestringRequired

Calendar name.

startTimestringRequired

Event start time (ISO).

customerNamestringOptional

Customer name.

currencystringRequired

Currency code.

Response example

application/json
{
  "summary": {
    "totalEvents": 0,
    "cancelledEvents": 0,
    "cancellationRate": 0,
    "lostRevenue": 0
  },
  "byCalendar": [
    {
      "calendarId": 0,
      "calendarName": "example_calendarName",
      "totalEvents": 0,
      "cancelledEvents": 0,
      "cancellationRate": 0
    }
  ],
  "byDayOfWeek": [
    {
      "dayOfWeek": 0,
      "dayName": "example_dayName",
      "totalEvents": 0,
      "cancelledEvents": 0,
      "cancellationRate": 0
    }
  ],
  "recentCancellations": [
    {
      "eventId": 0,
      "eventTitle": "example_eventTitle",
      "calendarName": "example_calendarName",
      "startTime": "example_startTime",
      "customerName": "example_customerName"
    }
  ],
  "currency": "example_currency"
}

Request example

GET /bff/dashboard/cancelled-events

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/cancelled-events?days=30" \
  -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