Read the significant events

deprecated

Base URL: https://{kibana_url}

GET /api/streams/{name}/significant_events
GET /s/{space_id}/api/streams/{name}/significant_events

Refer to Spaces for more information.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Query parameters

Request body

Response

200

Significant events for the stream.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/streams/NAME/significant_events?from=FROM&to=TO&bucketSize=BUCKET_SIZE
{}

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/streams/${NAME}/significant_events?from=${FROM}&to=${TO}&bucketSize=${BUCKET_SIZE}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the API spec

Response

{
  "aggregated_occurrences": [
    {
      "count": 42,
      "date": "2025-01-15T10:00:00.000Z"
    },
    {
      "count": 18,
      "date": "2025-01-15T11:00:00.000Z"
    },
    {
      "count": 7,
      "date": "2025-01-15T12:00:00.000Z"
    }
  ],
  "queries": [
    {
      "change_points": {
        "type": {
          "spike": {
            "change_point": 1,
            "p_value": 0.002
          }
        }
      },
      "description": "Count error-level log events grouped by host name",
      "esql": {
        "query": "FROM logs.nginx | WHERE log.level == \u0022error\u0022 | STATS count = COUNT(*) BY host.name"
      },
      "id": "error-count-by-host",
      "occurrences": [
        {
          "count": 42,
          "date": "2025-01-15T10:00:00.000Z"
        },
        {
          "count": 18,
          "date": "2025-01-15T11:00:00.000Z"
        },
        {
          "count": 7,
          "date": "2025-01-15T12:00:00.000Z"
        }
      ],
      "rule_backed": false,
      "severity_score": 75,
      "stream_name": "logs.nginx",
      "title": "Error count by host",
      "type": "match"
    }
  ]
}