This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Get overall buckets API Get filters API »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Machine learning anomaly detection APIs

Get scheduled events API

edit

Get scheduled events API

edit

Retrieves information about the scheduled events in calendars.

Request

edit

GET _ml/calendars/<calendar_id>/events

GET _ml/calendars/_all/events

Prerequisites

edit

Requires the monitor_ml cluster privilege. This privilege is included in the machine_learning_user built-in role.

Description

edit

For more information, see Calendars and scheduled events.

Path parameters

edit
<calendar_id>

(Required, string) A string that uniquely identifies a calendar.

You can get scheduled event information for multiple calendars in a single API request by using a comma-separated list of ids or a wildcard expression. You can get scheduled event information for all calendars by using _all or * as the calendar identifier.

Query parameters

edit
end
(Optional, string) Specifies to get events with timestamps earlier than this time.
from
(Optional, integer) Skips the specified number of events. Defaults to 0.
job_id
(Optional, 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
(Optional, integer) Specifies the maximum number of events to obtain. Defaults to 100.
start
(Optional, string) Specifies to get events with timestamps after this time.

Request body

edit

You can also specify the query parameters in the request body; the exception are from and size, use page instead:

page
Properties of page
from
(Optional, integer) Skips the specified number of events. Defaults to 0.
size
(Optional, integer) Specifies the maximum number of events to obtain. Defaults to 100.

Response body

edit

The API returns an array of scheduled event resources, which have the following properties:

calendar_id
(string) A string that uniquely identifies a calendar.
description
(string) A description of the scheduled event.
end_time
(date) The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.
event_id
(string) An automatically-generated identifier for the scheduled event.
start_time
(date) The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.

Examples

edit
resp = client.ml.get_calendar_events(
    calendar_id="planned-outages",
)
print(resp)
response = client.ml.get_calendar_events(
  calendar_id: 'planned-outages'
)
puts response
const response = await client.ml.getCalendarEvents({
  calendar_id: "planned-outages",
});
console.log(response);
GET _ml/calendars/planned-outages/events

The API returns the following results:

{
  "count": 3,
  "events": [
    {
      "description": "event 1",
      "start_time": 1513641600000,
      "end_time": 1513728000000,
      "calendar_id": "planned-outages",
      "event_id": "LS8LJGEBMTCMA-qz49st"
    },
    {
      "description": "event 2",
      "start_time": 1513814400000,
      "end_time": 1513900800000,
      "calendar_id": "planned-outages",
      "event_id": "Li8LJGEBMTCMA-qz49st"
    },
    {
      "description": "event 3",
      "start_time": 1514160000000,
      "end_time": 1514246400000,
      "calendar_id": "planned-outages",
      "event_id": "Ly8LJGEBMTCMA-qz49st"
    }
  ]
}

The following example retrieves scheduled events that occur within a specific period of time:

resp = client.ml.get_calendar_events(
    calendar_id="planned-outages",
    start="1635638400000",
    end="1635724800000",
)
print(resp)
response = client.ml.get_calendar_events(
  calendar_id: 'planned-outages',
  start: 1_635_638_400_000,
  end: 1_635_724_800_000
)
puts response
const response = await client.ml.getCalendarEvents({
  calendar_id: "planned-outages",
  start: 1635638400000,
  end: 1635724800000,
});
console.log(response);
GET _ml/calendars/planned-outages/events?start=1635638400000&end=1635724800000
« Get overall buckets API Get filters API »