Retrieving Events Using Filters and
offset
As an alternative to using the event stream, you can specify multiple filters to narrow down a subset of events, then optionally provide an offset value to paginate through the resulting dataset. When you specify
offset as a query parameter, the API returns a
totalCount value indicating the number of events that match your specified filters.
For example, to page through the audit trail for a specific administrator, you can query the /
events/audit endpoint with their
actorId. By default, this returns events sorted by
eventTime, but you can specify the
sortBy query parameter to instead group the audit events by type:
/events/audit?actorId=3422d5b6-12a9-4663-2dd7-a6b1822d0133&sortBy=auditEventType&limit=20For the next page of 20 additional events, use an offset value of 20:
/events/audit?actorId=3422d5b6-12a9-4663-2dd7-a6b1822d0133&sortBy=auditEventType&limit=20&offset=20