This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
When querying attendance information, you can query from the perspective of:
For example, query by a course's bookingId
and status = "NOT_ATTENDED"
to
retrieve the attendance of a given participant in a course. For example, this query
helps you determine if a participant booked the course
but did not attend most of its sessions, taking away spots for other potential participants.
Query Attendance runs with the following defaults, which you can override:
id
sorted in ASC
ordercursorPaging.limit
is 50
For field support, see supported filters.
Notes:
withBookingAttendanceDetails
as true
.To learn about working with query endpoints, see API Query Language.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,in() ,ascending() |
bookingId | eq() ,ne() ,in() ,ascending() |
sessionId | eq() ,ne() ,in() ,ascending() |
status | eq() ,ne() ,in() ,ascending() |
numberOfAttendees | eq() ,ne() ,in() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |