Retrieve a batch of records, or continuously stream.
seq_num
timestamp
tail_offset
(the number of records before the tail)append
has received an acknowledgment before the read
request is made, the response will reflect the write.count
or bytes
size, or until
a specific timestamp.
ReadSession
(available via most SDKs) or using SSE, you are able to read in a streaming fashion. If a limit is not specified and the end of the stream is reached, the session goes into real-time tailing mode and will return records as they are appended to the stream.
Accept: text/event-stream
header.
Bearer authentication header of the form Bearer <token>
, where <token>
is your access token.
Defines the interpretation of record data (header name, header value, and body) with the JSON content type.
Use raw
(default) for efficient transmission and storage of Unicode data — storage will be in UTF-8.
Use base64
for safe transmission with efficient storage of binary data.
raw
, base64
Stream name.
Start from a sequence number.
x >= 0
Start from a timestamp.
x >= 0
Start from number of records before the next sequence number.
x >= 0
Limit total records to return. If this is provided, tailing will be disabled.
x >= 0
Limit total metered bytes to return. If this is provided, tailing will be disabled.
x >= 0
Exclusive timestamp to read until. If this is provided, tailing will be disabled.
x >= 0
Clamp the start position at the tail position. If set, the read will start at the tail of the stream if the requested position is greater than it.
The response is of type object
.