STstreamkap
Destinations

Per-topic consumer lag for a destination

Changed on

Current consumer lag per topic (default), or lag at a point in time when at is given. Values are totals: one sample per partition, summed per topic and across topics, so they can be reconciled with alerts. at within the last 2 days is served at minute resolution, within 14 days at hour resolution; older or future values return HTTP 400. When no sample exists near at the response carries resolution: null and a message instead of zeros. latency_ms is best-effort and only available in current mode. at without a timezone is treated as UTC. Destinations list every topic their consumer group reports, including topics without a stored record.

get/destinations/{destination_id}/lag

Request

Path parameters

destination_idstring required

Query parameters

atstring date-time nullable

Point in time (ISO 8601). Omit for current lag.

Example:2026-09-09T10:00:00Z
topic_namestring nullable

Case-insensitive substring filter on the topic name

sort'lag' | 'name' | 'latency'
sort_dir'asc' | 'desc'
pageinteger
page_sizeinteger
include_partitionsboolean

Return the per-partition breakdown for each topic

Response

Successful Response

entity_typestring required
entity_idstring required
connector_namestring required
supportedboolean required

False for connectors that expose no consumer lag (kafkadirect)

mode'current' | 'historical' required
requested_atstring date-time nullable

Echo of the at query parameter

as_ofstring date-time nullable

Observation time actually used for the values

resolution'raw' | 'minute' | 'hour' nullable

raw (current), minute (<= 2d), hour (<= 14d); null when no data was found

staleboolean required

Current mode: newest sample is older than the stale threshold or missing

messagestring nullable

Human-readable note when data is missing or unsupported

totalinteger required

Topics matching the filter, before pagination

pageinteger required
page_sizeinteger required

Changes