Events report

POST/v1/EventReport/GetEventsReport
Scope: event.read

Retrieve summary statistics of event modifications.

Use this report to understand how events have changed over a period. Results can be filtered by modification date, company, affiliate group, and event identifier.

Aggregate record modified

Each report row includes an aggregateRecordModified timestamp in addition to the existing recordModified timestamp.

  • recordModified changes only when the event itself is edited.
  • aggregateRecordModified changes when the event or any of its child records — such as meeting rooms, accommodations, commissions, assignments, entity links, permissions, operations records, cancellation records, or extended properties — are added, updated, or soft-deleted. For example, updating a meeting room booking updates the event's aggregateRecordModified, but not necessarily its recordModified.

When you filter by modifiedSince and modifiedUntil, the API returns rows where either recordModified or aggregateRecordModified falls within the range. This ensures downstream consumers do not miss changes that occurred only on child records.

Request body

Parameters

pageNumberintegerOptional
Page number for pagination. Defaults to 1.
pageSizeintegerOptional
Page size for pagination. Defaults to 100.
modifiedSincedate-timeRequired
Filter events modified on or after this date. Matches when either the event's own `recordModified` or its aggregate `aggregateRecordModified` timestamp falls within the range.
modifiedUntildate-timeOptional
Filter events modified on or before this date. Matches when either the event's own `recordModified` or its aggregate `aggregateRecordModified` timestamp falls within the range.
companyIdintegerOptional
Filter to a specific company identifier.
affiliateGroupIdintegerOptional
Filter to a specific affiliate group identifier.
eventIdintegerOptional
Filter to a specific event identifier.
includeDeletedbooleanOptional
When true, include soft-deleted events and their child records in the results.
expand.meetingRoomsbooleanOptional
Include meeting room details.
expand.accommodationsbooleanOptional
Include accommodation details.
expand.commissionsbooleanOptional
Include commission details.
expand.entityLinksbooleanOptional
Include linked entity details.
expand.permissionsbooleanOptional
Include permission details.
expand.operationsRecordbooleanOptional
Include operations record details.
expand.assignmentsbooleanOptional
Include assignment details.
expand.cancellationRecordbooleanOptional
Include cancellation record details.
expand.extendedPropertiesbooleanOptional
Include extended property values.

Response

Returns a list of EventReporting objects.

The EventReporting object

eventIdinteger

Unique event identifier.

namestring

Display name of the event.

startDatedate-time

Start date and time of the event.

endDatedate-time

End date and time of the event.

statusstring

Current status of the event.

formTypestring

Form type associated with the event.

locationstring

Location text for the event.

attendeesinteger

Total number of attendees.

inPersonAttendeesinteger

Number of in-person attendees.

externalIdstring

External identifier for the event.

townstring

Town or city of the event.

paymentMethodstring

Payment method for the event.

companyIdinteger

Identifier of the company that owns the event.

affiliateIdinteger

Identifier of the affiliate group, if applicable.

externalUrlstring

External URL associated with the event.

recordCreateddate-time

When the event was created.

recordModifieddate-time

When the event was last modified.

aggregateRecordModifieddate-time

When the event or any of its child records were last modified.

isDeletedboolean

Whether the event has been soft-deleted.

Expandable collections

meetingRoomsarray

Meeting rooms booked for the event. Requires expand.meetingRooms.

accommodationsarray

Accommodation requirements for the event. Requires expand.accommodations.

commissionobject

Commission details for the event. Requires expand.commissions.

entityLinksarray

Links to other entities. Requires expand.entityLinks.

permissionsarray

Event permission records. Requires expand.permissions.

operationsRecordobject

Operations record for the event. Requires expand.operationsRecord.

assignmentsarray

Event assignments. Requires expand.assignments.

cancellationRecordobject

Cancellation record for the event, if any. Requires expand.cancellationRecord.

extendedPropertiesarray

Extended property values. Requires expand.extendedProperties.

Errors

StatusMeaning
400 Bad RequestValidation failed. Check the response for property-level errors.
401 UnauthorizedThe Bearer token is missing, expired, or lacks the required scope.
403 ForbiddenThe client is not permitted to view event data.
Example request
curl -X POST https://dashboard.alpha.meetingsbooker.com/reportingapi/v1/EventReport/GetEventsReport \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "modifiedSince": "2025-01-01T00:00:00Z",
    "modifiedUntil": "2025-01-31T23:59:59Z",
    "companyId": 1001
  }'