MAmacrometa
Streams

Get stats for the stream

Get the statistics for a stream.

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

Request

Path parameters

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..

Query parameters

getPreciseBacklogboolean

If set to true, returns precise backlog

subscriptionBacklogSizeboolean

If set to true, returns backlog size for each subscription.

Note: This requires locking the ledger so be careful not to use it when there's heavy traffic.

Response

Successfully fetched the stream statistics.

errorboolean

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

codeinteger

The generated response code.

resultstring

Stringified JSON object with statistics for the stream.

Example response

{
  "code": 200
}

Changes

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