Get info about events in calendars

GET /_ml/calendars/{calendar_id}/events

Auth

Required privileges

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

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _ml/calendars/planned-outages/events

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getCalendarEvents({
  calendar_id: "planned-outages",
});

Python Elasticsearch Python Client

resp = client.ml.get_calendar_events(
    calendar_id="planned-outages",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ml/calendars/planned-outages/events" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().getCalendarEvents(g -> g
    .calendarId("planned-outages")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.GetCalendarEventsAsync(calendarId: "planned-outages");

PHP Elasticsearch PHP Client

$resp = $client->ml()->getCalendarEvents([
    "calendar_id" => "planned-outages",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_calendar_events(
  calendar_id: "planned-outages"
)

Response

{
  "count": 0,
  "events": [
    {
      "calendar_id": "string",
      "event_id": "string",
      "description": "string",
      "end_time": "string",
      "start_time": "string"
    }
  ]
}

Generated from the API spec