Streams

Get backlog for the stream

Get the estimated backlog for the stream.

get/_fabric/{fabric}/_api/streams/{stream}/backlog

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/streams/:stream/backlog/get.ts
A function with typed inputs. Its response is checked against the schema.

fabricstring string required

Fabric name of the streams.

streamstring string required

The name of the stream (up to 240 characters). It should start with c8locals. or c8globals..

Successfully fetched the stream backlog.

errorboolean

Flag if there is an error in response. False for this response.

codeinteger

The generated response code.

resultstring

Stringified JSON object with backlog details

{
  "code": 200
}

No recorded changes to this operation across all 1 revision of this API.