Events report
/v1/EventReport/GetEventsReportevent.readRetrieve 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.
recordModifiedchanges only when the event itself is edited.aggregateRecordModifiedchanges 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'saggregateRecordModified, but not necessarily itsrecordModified.
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
pageNumberintegerOptionalpageSizeintegerOptionalmodifiedSincedate-timeRequiredmodifiedUntildate-timeOptionalcompanyIdintegerOptionalaffiliateGroupIdintegerOptionaleventIdintegerOptionalincludeDeletedbooleanOptionalexpand.meetingRoomsbooleanOptionalexpand.accommodationsbooleanOptionalexpand.commissionsbooleanOptionalexpand.entityLinksbooleanOptionalexpand.permissionsbooleanOptionalexpand.operationsRecordbooleanOptionalexpand.assignmentsbooleanOptionalexpand.cancellationRecordbooleanOptionalexpand.extendedPropertiesbooleanOptionalResponse
Returns a list of EventReporting objects.
The EventReporting object
eventIdintegerUnique event identifier.
namestringDisplay name of the event.
startDatedate-timeStart date and time of the event.
endDatedate-timeEnd date and time of the event.
statusstringCurrent status of the event.
formTypestringForm type associated with the event.
locationstringLocation text for the event.
attendeesintegerTotal number of attendees.
inPersonAttendeesintegerNumber of in-person attendees.
externalIdstringExternal identifier for the event.
townstringTown or city of the event.
paymentMethodstringPayment method for the event.
companyIdintegerIdentifier of the company that owns the event.
affiliateIdintegerIdentifier of the affiliate group, if applicable.
externalUrlstringExternal URL associated with the event.
recordCreateddate-timeWhen the event was created.
recordModifieddate-timeWhen the event was last modified.
aggregateRecordModifieddate-timeWhen the event or any of its child records were last modified.
isDeletedbooleanWhether the event has been soft-deleted.
Expandable collections
meetingRoomsarrayMeeting rooms booked for the event. Requires expand.meetingRooms.
accommodationsarrayAccommodation requirements for the event. Requires expand.accommodations.
commissionobjectCommission details for the event. Requires expand.commissions.
entityLinksarrayLinks to other entities. Requires expand.entityLinks.
permissionsarrayEvent permission records. Requires expand.permissions.
operationsRecordobjectOperations record for the event. Requires expand.operationsRecord.
assignmentsarrayEvent assignments. Requires expand.assignments.
cancellationRecordobjectCancellation record for the event, if any. Requires expand.cancellationRecord.
extendedPropertiesarrayExtended property values. Requires expand.extendedProperties.
Errors
| Status | Meaning |
|---|---|
400 Bad Request | Validation failed. Check the response for property-level errors. |
401 Unauthorized | The Bearer token is missing, expired, or lacks the required scope. |
403 Forbidden | The client is not permitted to view event data. |
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
}'