Get info about events in calendars

Auth

Required authorization

Cluster privileges monitor_ml

Path parameters

calendar_id string required

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 _all or * or by omitting the calendar identifier.

Query parameters

end union oneOf

Specifies to get events with timestamps earlier than this time.

One of: string or number
from number · default: 0

Skips the specified number of events.

job_id string

Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of _all or *.

size number · default: 100

Specifies the maximum number of events to obtain.

start union oneOf

Specifies to get events with timestamps after this time.

One of: string or number

Response

application/json
count number required
events object[] required
calendar_id string

A string that uniquely identifies a calendar.

event_id string
description string required

A description of the scheduled event.

end_time union oneOf required

The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.

One of: string or number
start_time union oneOf required

The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.

One of: string or number
skip_result boolean · default: true

When true the model will not create results for this calendar period.

skip_model_update boolean · default: true

When true the model will not be updated for this calendar period.

force_time_shift number

Shift time by this many seconds. For example adjust time for daylight savings changes