Sign in
significant_events

Read the significant events

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/streams/{name}/significant_events</span></div>

Refer to Spaces for more information.

Read the significant events<br/><br/>[Required authorization] Route required privileges: read_stream.

get/api/streams/{name}/significant_events

Path parameters

namestring required

The name of the stream.

Query parameters

fromstring required

Start of the time range as an ISO 8601 date string.

tostring required

End of the time range as an ISO 8601 date string.

bucketSizestring required

The bucket size for aggregating events (e.g. "1m", "1h").

querystring

Query string to filter significant events on metadata fields

searchMode'keyword' | 'semantic' | 'hybrid'

Search mode: keyword (BM25), semantic (vector), or hybrid (RRF). When omitted, defaults to hybrid with a silent keyword fallback on failure. When set explicitly, failures propagate as errors.

Request body

object required
OR
{"stackTrail":"paths:/api/streams/{name}/significant_events:get:requestBody:content:application/json:schema:anyOf:1","oasType":"schema","type":"unknown"}

Response

Significant events for the stream.

Changes

Changed in 1 of the 100 revisions of this API.11

  • f4def03bd2af11See the full diff
    • ▲

      removed subschema #2 from the request body anyOf list

      request-body-any-of-removed

    • ○

      the request's body became nullable

      request-body-became-nullable