Skip to main content
GET
Get a subscription's delivery health

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization
string

Bearer token, relayed to the streaming-hub as server-to-server auth.

Ejemplo:

"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJvcHMifQ.signature"

Parámetros de ruta

id
string
requerido

Subscription id.

Ejemplo:

"0192f1a0-0000-7000-8000-0000000000ff"

Respuesta

OK

auto_disabled
boolean | null
requerido

Endpoint-health auto-disable verdict: null when the hub has no health row yet, false when healthy, true when tripped. Null is never false.

Ejemplo:

false

consumer_lag_ms
integer<int64>
requerido

Process consumer lag behind the high watermark, in milliseconds.

Ejemplo:

120

dead_lettered
integer<int64>
requerido

Count of dead-lettered delivery attempts in the window.

Ejemplo:

2

delivery_outcomes
object
requerido

Delivery-attempt outcome counts over the hub's configured window, keyed by outcome.

Ejemplo:
disabled_reason
string | null
requerido

Fixed, secret-free auto-disable verdict token; null when the subscription was not auto-disabled.

Ejemplo:

"consecutive_failures"

dropped_tenant
boolean
requerido

Whether any events were dropped or quarantined for this tenant.

Ejemplo:

false

enabled
boolean
requerido

Whether delivery is enabled (manual operator toggle).

Ejemplo:

true

last_failure_at
string<date-time> | null
requerido

Instant of the last failed delivery; null when there has never been one.

Ejemplo:

"2026-01-15T09:29:00Z"

last_success_at
string<date-time> | null
requerido

Instant of the last successful delivery; null when there has never been one.

Ejemplo:

"2026-01-15T09:30:00Z"

poison_events
integer<int64>
requerido

Count of quarantined poison events for this tenant.

Ejemplo:

0

recent_outcomes
object
requerido

Last-24h delivery-outcome breakdown, keyed by outcome.

Ejemplo:
status
string
requerido

Rolled-up operator status (Healthy, Degraded, Down). A free string, not a closed vocabulary.

Ejemplo:

"Healthy"

subscription_id
string
requerido

The subscription this health view is for.

Ejemplo:

"0192f1a0-0000-7000-8000-0000000000ff"

success_rate
number<double> | null
requerido

Share of terminal delivery attempts that succeeded, in [0.0, 1.0]; null when no terminal attempt has happened yet. Null is never zero.

Ejemplo:

0.98

verification_state
string
requerido

Position in the destination verification state machine (pending_verification, active, degraded, disabled). A free string, not a closed vocabulary.

Ejemplo:

"active"