Skip to content
campaiDeveloper
campai.com

Booking · Events · Statistics

GET/{organizationId}/{mandateId}/booking/events/statistics/attendanceReads only

Get event attendance

Returns the events ending in a period and in the period of the same length right before it: how many there were, their attendees, canceled attendees and attendees on the waitlist, how full the events with a seat limit were and how many attendees of past events checked in. Also returns the attendees per month and the five events with the most attendees. Attendees are people who are confirmed or checked in. Canceled and blocked events are left out

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • event.read
  • attendee.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Query parameters

  • fromDatestringrequired
  • toDatestringrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/events/statistics/attendance' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • summaryobject
    12 properties
    • eventCountinteger

      at least 0

    • previousEventCountinteger

      at least 0

    • attendeeCountinteger

      at least 0

    • previousAttendeeCountinteger

      at least 0

    • utilizationRatenumbernullable

      at least 0

    • previousUtilizationRatenumbernullable

      at least 0

    • checkInRatenumbernullable

      at least 0

    • previousCheckInRatenumbernullable

      at least 0

    • canceledCountinteger

      at least 0

    • previousCanceledCountinteger

      at least 0

    • waitlistedCountinteger

      at least 0

    • previousWaitlistedCountinteger

      at least 0

  • monthsobject[]
    3 properties
    • datestring
    • confirmedinteger

      at least 0

    • checkedIninteger

      at least 0

  • topEventsobject[]
    4 properties
    • _idid
    • titlestring
    • datestring · date-time
    • attendeeCountinteger

      at least 0

Response200
{
  "summary": {
    "eventCount": 0,
    "previousEventCount": 0,
    "attendeeCount": 0,
    "previousAttendeeCount": 0,
    "utilizationRate": 0,
    "previousUtilizationRate": 0,
    "checkInRate": 0,
    "previousCheckInRate": 0,
    "canceledCount": 0,
    "previousCanceledCount": 0,
    "waitlistedCount": 0,
    "previousWaitlistedCount": 0
  },
  "months": [
    {
      "date": "string",
      "confirmed": 0,
      "checkedIn": 0
    }
  ],
  "topEvents": [
    {
      "_id": "000000000000000000000001",
      "title": "string",
      "date": "2026-06-15T22:30:00Z",
      "attendeeCount": 0
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.