Get info about events in calendars
- GET /_ml/calendars/{calendar_id}/events
- Cluster privileges:
monitor_ml
Path Parameters
-
calendar_idstring Idrequired -
A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using
_allor*or by omitting the calendar identifier.
Query Parameters
-
endDateTime Specifies to get events with timestamps earlier than this time.
-
fromnumber · default: 0 Skips the specified number of events.
-
job_idstring Id Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of
_allor*.-
sizenumber · default: 100 Specifies the maximum number of events to obtain.
-
startDateTime Specifies to get events with timestamps after this time.
Response
-
countnumberrequired -
eventsCalendarEventrequired -
calendar_idstring Id -
A string that uniquely identifies a calendar.
-
event_idstring Id -
descriptionstringrequired -
A description of the scheduled event.
-
end_timeDateTimerequired -
The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.
-
start_timeDateTimerequired -
The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.
-
skip_resultboolean · default: true -
When true the model will not create results for this calendar period.
-
skip_model_updateboolean · default: true -
When true the model will not be updated for this calendar period.
-
force_time_shiftnumber -
Shift time by this many seconds. For example adjust time for daylight savings changes