Engine

Covers Engine 2.0.0

argus/get-active-events

Returns active events.

  • Category: Events

Request payload

FieldTypeRequirementDescription
systemstringOptionalExact ARGUS system filter.
subsystemstringOptionalExact ARGUS subsystem filter.
typestringOptionalExact event-type filter.
statusstringOptionalExact event-status filter.
nodestringOptionalExact originating-node filter.
channelstringOptionalExact related-channel filter.
textstringOptionalFree-text filter. query is accepted as an alias.
querystringOptionalAlias for text.
session_idstringOptionalExact ARGUS session filter.
from_nsintegerOptionalInclusive lower timestamp bound in Unix-epoch nanoseconds; zero disables the bound.
to_nsintegerOptionalInclusive upper timestamp bound in Unix-epoch nanoseconds; zero disables the bound.
limitintegerOptionalMaximum event count; defaults to 500 and is clamped to at most 2000 when merging nodes.
offsetintegerOptionalZero-based result offset; defaults to 0.
active_onlybooleanOptionalAccepted for query compatibility; this operation always returns active events.

Response payload

FieldTypeDescription
eventsarray<ArgusEvent>Active events merged from the local engine and connected remote engines, newest first.
countintegerNumber of events in this page.
total_countintegerTotal active-event count before pagination.