Skip to main content

Module api

Module api 

Source

Structs§

BulkGetStateRequest
Bulk get projection states for multiple entities
BulkSaveStateItem
BulkSaveStateRequest
Bulk save projection states for multiple entities
ConsumerPollQuery
GET /api/v1/consumers/{consumer_id}/events — Poll for events since last ack
EntityStateParams
GetSchemaParams
ListDeliveriesParams
Query parameters for listing webhook deliveries
ListEventTypesParams
Query parameters for listing event types
ListEventTypesResponse
Response for listing event types
ListStreamsParams
Query parameters for listing streams
ListStreamsResponse
Response for listing streams
ListWebhooksParams
Query parameters for listing webhooks
SaveProjectionStateRequest
Request body for saving projection state
SetCompatibilityRequest
WebSocketParams

Functions§

ack_consumer
POST /api/v1/consumers/{consumer_id}/ack — Acknowledge processed events
all_pipeline_stats
analytics_correlation
analytics_frequency
analytics_summary
bulk_get_projection_states
bulk_save_projection_states
Bulk save projection states for multiple entities
cancel_replay
compaction_stats
create_snapshot
delete_projection
Delete (clear) a projection by name
delete_replay
delete_webhook
Delete a webhook subscription
detect_duplicates
events_websocket
exactly_once_stats
Exactly-once processing stats
geo_query
Geospatial: Query events by location
geo_stats
Geospatial index stats
get_consumer
GET /api/v1/consumers/{consumer_id} — Get consumer metadata and cursor position
get_entity_snapshot
get_entity_state
get_event_by_id
Get a single event by UUID
get_latest_snapshot
get_pipeline
get_pipeline_stats
get_projection
Get projection metadata by name
get_projection_state
Get projection state for a specific entity
get_projection_state_summary
Get aggregate projection state (all entities)
get_replay_progress
get_schema
get_stats
get_webhook
Get a specific webhook by ID
graphql_query
GraphQL: Execute GraphQL queries
health
ingest_event
ingest_event_v1
Ingest a single event with semi-sync/sync replication ACK waiting.
ingest_events_batch
Batch ingest multiple events in a single request
ingest_events_batch_v1
Batch ingest with semi-sync/sync replication ACK waiting.
list_entities
list_event_types
list_pipelines
list_projections
List all registered projections
list_replays
list_schema_versions
list_snapshots
list_streams
list_subjects
list_webhook_deliveries
List delivery history for a webhook
list_webhooks
List webhooks, optionally filtered by tenant_id
pause_projection
Pause a projection
poll_consumer_events
prometheus_metrics
query_events
register_consumer
POST /api/v1/consumers — Register a durable consumer
register_pipeline
register_schema
register_webhook
Register a new webhook subscription
remove_pipeline
reset_pipeline
reset_projection
Reset a projection to its initial state
save_projection_state
Save/update projection state for an entity
schema_evolution_history
Schema evolution history for an event type
schema_evolution_schema
Current inferred schema for an event type
schema_evolution_stats
Schema evolution stats
serve
set_compatibility_mode
start_projection
Start (resume) a projection
start_replay
trigger_compaction
update_webhook
Update a webhook subscription
validate_event_schema