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 string | number

  Specifies to get events with timestamps earlier than this time.

• from number

  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

  Specifies the maximum number of events to obtain.

• start string | number

  Specifies to get events with timestamps after this time.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • count number Required
  • events array[object] Required
    Hide events attributes Show events attributes object

    • calendar_id string
    • event_id string
    • description string Required

      A description of the scheduled event.

    • end_time string | number Required

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • start_time string | number Required

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • skip_result boolean

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

    • skip_model_update boolean

      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