read.internal.relay_depth

How far behind this tenant’s event relay is, per consumer and in total: remaining (events still owed), dead_lettered (deliveries given up on) and settled — true only when every consumer answered a number and every number is zero. A consumer with no registration yet (unregistered) or whose tables this schema lacks (inactive) answers null, never 0: “nothing owed” and “no idea” are different facts. ★ A BIRTH WAITS ON state_settled, NEVER ON settled: each consumer also publishes builds_state (whether it builds state somebody reads, derived from what it declares about its own history), and state_settled / state_remaining fold up only those — so a mail consumer whose provider refuses every address cannot hold a box open, measured at ~12h on one. Use it to tell a box that is still assembling itself from one that is done: a freshly seeded instance can owe tens of thousands of events for an hour, and the storefront reads the projections meanwhile. Internal face only.

• Surface: GET /v1/read/internal/relay_depth · MCP tool read.internal.relay_depth
• Auth: ★ Internal read (operator) — a tenant credential is REQUIRED; requires the tenant.settings.read scope. The tenant is resolved from the CALLER’s identity, never from store. Personal fields come back MASKED for an actor without pii.read (the shape is unchanged).

Params (JSON Schema)

{
  "properties": {},
  "type": "object"
}

Result (200)

Open (unknown) — this capability does not declare an output schema.

Errors

invalid_params (400) · not_found (404) · unauthorized (401) · forbidden (403)