Skip to main content

List Events

GET 

/sessions/:session_id/events

Lists events from a session with optional filtering and waiting capabilities.

This endpoint retrieves events from a specified session and can:

  1. Filter events by their offset, source, type, and correlation ID
  2. Wait for new events to arrive if requested
  3. Return events in chronological order based on their offset

Notes: Long Polling Behavior:

  • When wait_for_data = 0: Returns immediately with any existing events that match the criteria
  • When wait_for_data > 0:
    • If new matching events arrive within the timeout period, returns with those events
    • If no new events arrive before timeout, raises 504 Gateway Timeout
    • If matching events already exist, returns immediately with those events

Request

Responses

List of events matching the specified criteria