8.5.26 EventReportRequest

The EventReportRequest specifies the filters to be applied when generating an EventReport. It has to be sent with an /api/v1/eventreport POST call.

Data Model

Key Type Value
from String Specifies the start of the time range of the report. Must be formatted following ISO 8601, example: 2021-03-26T08:02:30Z, time zone is always UTC.
to String Specifies the end of the time range of the report. Must be formatted following ISO 8601, example: 2021-03-26T08:02:30Z, time zone is always UTC. May be null if length is not zero.
length Number The length of the time range of the report in hours. If this value is zero, the report length is determines as the difference to - from. If the value is not null, the to value is ignored and length is used as the report length.
mnc String The M&C name filter. Only events containing this text in their source1 (M&C name) field are included in the report. If mnc is null, all events pass this filter.
device String The device name filter. Only events containing this text in their source2 (device name) field are included in the report. If device is null, all events pass this filter.
host String The host name filter. Only events containing this text in their origin1 (host name) field are included in the report. If host is null, all events pass this filter. Please note that only parameter change events have a host name set, other events will never match this filter.
user String The user name filter. Only events containing this text in their origin2 (user name) field are included in the report. If user is null, all events pass this filter. Please note that only parameter change events have a user name set, other events will never match this filter.
maxlen Number The maximum length of the report (number of event messages). If more events than this number match the filter settings, only the oldest maxlen events of these will be contained in the report. If maxlen is null, the server side default for the maximum report length is used.
pri String The event priority filter. Must contain one of the following:
ALL = include all events (no filter)
INFO = include the events with priority INFO or higher
INFO-ONLY = include the events with exactly priority INFO
WARNING = include the events with priority WARNING or higher
WARNING-ONLY = include the events with exactly priority WARNING
FAULT = include the events with priority FAULT or higher
FAULT-ONLY = include the events with exactly priority FAULT
text String The message text filter. Only messages which contain the given text are included in the report. If text consists of multiple words separated by space characters, the message text must contain all these words in arbitrary sequence. If text is null, all events pass this filter.