QueryEventsOptions
API reference for QueryEventsOptions
Interface: QueryEventsOptions
Section titled “Interface: QueryEventsOptions”Query parameters for filtering events
Properties
Section titled “Properties”eventId?
Section titled “eventId?”
optionaleventId:string
fromDate?
Section titled “fromDate?”
optionalfromDate:string
fromPosition?
Section titled “fromPosition?”
optionalfromPosition:number
includeArchived?
Section titled “includeArchived?”
optionalincludeArchived:boolean
includeCount?
Section titled “includeCount?”
optionalincludeCount:boolean
limit?
Section titled “limit?”
optionallimit:number
offset?
Section titled “offset?”
optionaloffset:number
phase?
Section titled “phase?”
optionalphase:number
sortBy?
Section titled “sortBy?”
optionalsortBy:"globalPosition"|"createdAt"|"streamPosition"
sortDirection?
Section titled “sortDirection?”
optionalsortDirection:"asc"|"desc"
streamId?
Section titled “streamId?”
optionalstreamId:string
toDate?
Section titled “toDate?”
optionaltoDate:string
toPosition?
Section titled “toPosition?”
optionaltoPosition:number
transactionId?
Section titled “transactionId?”
optionaltransactionId:string
optionaltype:string|string[]