Get events

View as Markdown
Get list of events with optional filtering by node UUID, component, and time range. Returns events from the events table for the specified time period.

Query parameters

startTimestringOptional

Start time in RFC3339 format (required for absolute mode, e.g., 2024-01-01T01:00:00Z). Cannot be more than 1 year in the past.

endTimestringOptional

End time in RFC3339 format (required for absolute mode, e.g., 2024-01-01T01:00:00Z)

timeModeenumOptional
Time mode for range selection. Defaults to absolute.
Allowed values:
windowstringOptional

Relative duration window (required for relative mode). Valid units: h, m, s (e.g. 24h, 1h30m, 90m). ‘d’ is not supported; use hours instead (e.g. 168h for 7 days)

nodeUUIDstringOptional

Filter by node UUID (optional)

componentstringOptional

Filter by component (optional)

pageintegerOptionalDefaults to 0

Page number (default: 0)

pageSizeintegerOptionalDefaults to 50

Page size (default: 50, max: 100)

Response

Array of events with pagination info
eventslist of objectsOptional
hasMorebooleanOptional
pageintegerOptional
pageSizeintegerOptional
totalintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
499
Client Closed Request Error
500
Internal Server Error
503
Service Unavailable Error