Get the operational dashboard snapshot

Returns one consistent read of the tenant’s hub: a point-in-time subscription census and push backlog, plus ingestion, push-delivery, and pull-eligibility counts over the selected period, with a time series. The period is [from, to), or the rolling window_hours width that ends at the hub’s snapshot instant. A count is 0 when nothing matched; null means the fact does not exist. This route never consumes events and never moves a pull cursor. Authorization checks the resource dashboard and the action get.

GET /v1/dashboard

Get the operational dashboard snapshot

cURL

curl --request GET \
  --url https://streaming-hub.sandbox.lerian.net/v1/dashboard \
  --header 'Authorization: Bearer <token>'

200

{
  "snapshot_at": "2026-09-11T12:00:00Z",
  "coverage_start": "2026-09-04T00:00:00Z",
  "window_start": "2026-09-10T12:00:00Z",
  "window_end": "2026-09-11T12:00:00Z",
  "current_state": {
    "subscriptions": {
      "total": 12,
      "paused": 1,
      "by_enabled": {
        "enabled": 10,
        "disabled": 2
      },
      "by_verification_state": {
        "pending_verification": 1,
        "active": 9,
        "degraded": 0,
        "disabled": 0
      },
      "by_sink_kind": {
        "webhook": 7,
        "sqs": 2,
        "rabbitmq": 1,
        "eventbridge": 1,
        "pull": 1
      },
      "by_channel": {
        "push": 11,
        "pull": 1
      }
    },
    "push": {
      "pending_jobs": 3,
      "oldest_pending_job_age_seconds": 42
    }
  },
  "selected_period": {
    "events_received": 1280,
    "push": {
      "delivery_jobs_created": 640,
      "delivery_attempts": {
        "delivered": 600,
        "failed": 30,
        "dead_lettered": 6,
        "disabled": 2,
        "available": 1,
        "poison": 1
      }
    },
    "pull": {
      "eligible_events": 420,
      "eligible_subscription_matches": 440
    },
    "pull_omitted_reason": "window_exceeds_pull_ceiling",
    "pull_window_ceiling_hours": 48,
    "time_series": [
      {
        "bucket_start": "2026-09-10T12:00:00Z",
        "bucket_end": "2026-09-10T13:00:00Z",
        "events_received": 53,
        "push": {
          "delivery_jobs_created": 640,
          "delivery_attempts": {
            "delivered": 600,
            "failed": 30,
            "dead_lettered": 6,
            "disabled": 2,
            "available": 1,
            "poison": 1
          }
        },
        "pull": {
          "eligible_events": 420,
          "eligible_subscription_matches": 440
        }
      }
    ]
  }
}

Autorizaciones

Authorization · string · header · requerido

A bearer JWT issued by Access Manager. The /v1 surface never reads a tenant from the body, path, or query. Machine callers obtain a token with the Access Manager client-credentials flow. The /admin surface authorizes against an operator scope and carries no tenant context.

Parámetros de consulta

from · string<date-time>

The inclusive start of the period, an RFC 3339 instant. Defaults to the resolved to minus 24 hours.

to · string<date-time>

The exclusive end of the period, an RFC 3339 instant. Defaults to the snapshot instant; a later value is rejected. The period spans at most 30 days.

window_hours · integer

A rolling period width in whole hours, from 1 to 720: the window [snapshot_at - window_hours, snapshot_at) on the hub's clock. Use it for a preset period, such as the last 24 hours. It cannot be sent with from or to. To read the attention list over the same period, send this response's window_start and window_end to GET /v1/dashboard/subscriptions as from and to.

Respuesta

200

application/json

The dashboard snapshot.

snapshot_at · string<date-time> · requerido

The database instant the read observed (UTC, RFC 3339). Every current_state figure is true at this instant, and window_end is never after it.

Ejemplo:

"2026-09-11T12:00:00Z"

coverage_start · string<date-time> · requerido

The earliest instant of the uninterrupted retained history this read could count (UTC, RFC 3339). A period that starts before it is refused with 422 validation_error.

Ejemplo:

"2026-09-04T00:00:00Z"

window_start · string<date-time> · requerido

The inclusive start of the resolved period (UTC, RFC 3339). Every selected_period count is taken over [window_start, window_end).

Ejemplo:

"2026-09-10T12:00:00Z"

window_end · string<date-time> · requerido

The exclusive end of the resolved period (UTC, RFC 3339). It is snapshot_at when the request omits to.

Ejemplo:

"2026-09-11T12:00:00Z"

current_state · object · requerido

What the tenant's hub looks like at snapshot_at, independent of the period.

Show child attributes

selected_period · object · requerido

The counts over [window_start, window_end). Every count is 0 when none, never null.

Show child attributes