Skip to content
delta-base docs

Query events with filtering options

GET
/api/event-stores/{eventStoreName}/events

Retrieves events across all streams with flexible filtering options.

Key Features:

  • Filter events by multiple criteria including event type, ID, and timeframes
  • Paginate results with limit and offset parameters
  • Sort by different fields (global_position, created_at, stream_position)
  • Get total count for pagination (when include_count=true)

This endpoint is particularly useful for:

  • Building event dashboards or monitoring tools
  • Tracking specific event types across multiple streams
  • Auditing and troubleshooting application state changes
  • Generating reports based on event history

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
eventStoreName
required

Event store name (automatically scoped to your organization)

string

Event store name (automatically scoped to your organization)

Query Parameters

Section titled “Query Parameters ”
streamId
string
type
Any of:
string
eventId
string
transactionId
string
fromPosition
string
toPosition
string
fromDate
string format: date-time
toDate
string format: date-time
phase
string
includeArchived
string
limit
string
offset
string
sortBy
string
Allowed values: globalPosition createdAt streamPosition
sortDirection
string
Allowed values: asc desc
includeCount
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Events retrieved successfully

object
events
required
Array<object>
object
streamId
required
string
streamPosition
required
number
globalPosition
required
number
eventId
required
string
type
required
string
data
required
object
key
additional properties
nullable
metadata
object
key
additional properties
nullable
schemaVersion
required
string
transactionId
required
string
createdAt
required

ISO 8601 formatted timestamp in UTC

string
pagination
required
object
limit
required
number
offset
required
number
total
number
hasMore
required
boolean
Examples

Basic query result

Example of basic event query results with pagination

{
  "events": [
    {
      "streamId": "user-123",
      "streamPosition": 0,
      "globalPosition": 42,
      "eventId": "evt_123",
      "type": "user.created",
      "data": {
        "userId": "123",
        "email": "user@example.com"
      },
      "metadata": {
        "correlationId": "abc-123"
      },
      "schemaVersion": "1.0.0",
      "transactionId": "tx_123",
      "createdAt": "2023-01-15T12:30:45Z"
    },
    {
      "streamId": "order-456",
      "streamPosition": 0,
      "globalPosition": 43,
      "eventId": "evt_456",
      "type": "order.placed",
      "data": {
        "orderId": "456",
        "total": 99.99
      },
      "metadata": {
        "correlationId": "def-456"
      },
      "schemaVersion": "1.0.0",
      "transactionId": "tx_456",
      "createdAt": "2023-01-15T12:31:22Z"
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 2,
    "hasMore": false
  }
}

400

Section titled “400 ”

Invalid query parameters

object
error
required
string
Allowed values: Invalid request body
details
required
Array<object>
object
code
required
string
message
required
string
path
required
Array

401

Section titled “401 ”

Unauthorized: Organization ID not found in authentication context

object
error
required
string
Allowed values: UNAUTHORIZED
message
required
string
Allowed values: Unauthorized: Organization ID not found in authentication context
Examples
{
  "error": "UNAUTHORIZED",
  "message": "Unauthorized: Organization ID not found in authentication context"
}