NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

xpack.ml.getCalendarEvents

client.xpack.ml.getCalendarEvents({
  calendar_id: string,
  job_id: string,
  start: string,
  end: string,
  from: number,
  size: number
})

`calendar_id` or `calendarId`	`string` - The ID of the calendar containing the events
`job_id` or `jobId`	`string` - Get events for the job. When this option is used calendar_id must be _all
`start`	`string` - Get events after this time
`end`	`string` - Get events before this time
`from`	`number` - Skips a number of events
`size`	`number` - Specifies a max number of events to get