Get info about events in calendars

GET /_ml/calendars/{calendar_id}/events

Copy endpoint

Required authorization

Cluster privileges: monitor_ml

Parameters

path Path Parameters

Name	Type
`calendar_id` 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.	type TypesId = string

query Query Parameters

Name	Type
`end` Specifies to get events with timestamps earlier than this time.	type TypesDateTime = type TypesEpochTimeUnitMillis = TypesUnitMillis \| string
`from` Skips the specified number of events.	number
`job_id` 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 `*`.	type TypesId = string
`size` Specifies the maximum number of events to obtain.	number
`start` Specifies to get events with timestamps after this time.	type TypesDateTime = type TypesEpochTimeUnitMillis = TypesUnitMillis \| string

Responses

200 application/json

{ count: number;events:

MlTypesCalendarEvent

interface MlTypesCalendarEvent {
calendar_id?: TypesId;
event_id?: TypesId;
description: string;
end_time: TypesDateTime;
start_time: TypesDateTime;
skip_result?: boolean;
skip_model_update?: boolean;
force_time_shift?: number;
}

[]; }