List events

Returns an array of top-level information about events in your environment.

Because the response is paginated, the request body has a limit and offset field. At least one must be filled.

  • limit indicates how many objects the request returns (the page maximum is 50)
  • offset indicates the offset for pagination. An offset value of 1 starts with the environment's first record.
  • case_id is a filter. Only events with the associated case ID will be shown.
  • alert_id is a filter. Only events with the associated alert ID will be shown.
  • start_date is a filter. Only events that started on or after this date will be shown.
  • end_date is a filter. Only events that ended on or before this date will be shown.

The total_count field contains the total number of events where the response_count field contains the number of events included in the response.

Language
Authentication
Header
URL
Click Try It! to start a request and see the response here!