Skip to main content
GET
Get public event stream metadata

Authorizations

Authorization
string
header
required

Sign in with the existing Occtoo Studio identity and selected organization.

Query Parameters

filter
string

RFC 7644-derived event filter. Supports eq, and, or, parentheses and double-quoted strings. Example: (type eq "source.updated" and sourceId eq "products") or (type eq "segment.updated" and segmentId eq "summer-sale"). Filterable properties are listed by GET /v1/event-types.

Maximum string length: 4096

Response

The retained event boundaries and exact count matching the filter.

Metadata for the retained filtered tenant event stream.

first
null | object
required

Earliest retained matching event position, or null when there is no match.

latest
null | object
required

Latest retained matching event position, or null when there is no match.

after
null | string
required

Opaque cursor for the same position, suitable for the pull endpoint's after parameter, or null when there is no match.

Example:

"MDAzLjAwMDAwMDAwMDAwMDAwMTg0NDY3"

total
required

Exact number of retained events matching the filter.

Example:

42