Engine

Covers Engine 2.0.0

argus/query-events

Queries events from the local ARGUS store and connected DARTWIC Share nodes.

  • 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_onlybooleanOptionalRestrict results to active events; defaults to false.

Response payload

FieldTypeDescription
eventsarray<ArgusEvent>Matching events ordered by the ARGUS store.
countintegerNumber of events in this page.
total_countintegerTotal number of matching events before pagination.