events

List Events

Changed on

List ingested first-party events.

Requires the events:read scope on the API key.

get/v1/events

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/events
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_by'occurred_at'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

event_namestring nullable

Filter by event name.

resolution_status'PENDING' | 'RESOLVED' | 'UNRESOLVED'

Filter by resolution status.

external_event_idstring nullable

Filter by external event id.

occurred_at_afterstring date-time nullable

Return events strictly after this timestamp (exclusive).

occurred_at_beforestring date-time nullable

Return events strictly before this timestamp (exclusive).

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.

Changes