Get dispatch health dashboard

Dispatch outbox health per brand.

GET /v1/dispatch/health

cURL

curl --request GET \
  --url 'https://api.workstream.stateset.com/v1/dispatch/health' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"

200

{
  "generated_at": "2026-08-31T14:22:05Z",
  "window_minutes": 1,
  "summary": {
    "active_tenants": 1,
    "active_brands": 1,
    "healthy_brands": 1,
    "pending_count": 1,
    "processing_count": 1,
    "failed_count": 1,
    "dead_letter_count": 1,
    "warning_brands": 1,
    "critical_brands": 1,
    "max_oldest_pending_seconds": 250,
    "max_tenant_event_rate_utilization": 7.5,
    "max_brand_event_rate_utilization": 7.5,
    "max_tenant_inflight_utilization": 1.5,
    "max_brand_inflight_utilization": 1.5,
    "max_parity_mismatch_rate_24h": 7.5
  },
  "items": [
    {
      "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenant_name": "string",
      "tenant_status": "string",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_slug": "acme-outdoors",
      "brand_display_name": "string",
      "brand_status": "string",
      "routing_mode": "string",
      "pending_count": 1,
      "processing_count": 1,
      "failed_count": 1,
      "dead_letter_count": 1,
      "oldest_pending_seconds": 250,
      "oldest_failed_seconds": 250,
      "tenant_events_last_minute": 1,
      "brand_events_last_minute": 1,
      "tenant_inflight_count": 1,
      "brand_inflight_count": 1,
      "tenant_events_per_minute_limit": 1,
      "brand_events_per_minute_limit": 1,
      "tenant_inflight_limit": 1,
      "brand_inflight_limit": 1,
      "tenant_event_rate_utilization": 7.5,
      "brand_event_rate_utilization": 7.5,
      "tenant_inflight_utilization": 1.5,
      "brand_inflight_utilization": 1.5,
      "parity_mismatch_rate_24h": 7.5,
      "health_status": "string",
      "alerts": []
    }
  ],
  "limit": 20,
  "offset": 1,
  "count": 2
}

Response

object

generated_at · string (date-time) · required

window_minutes · integer · required

summary · object · required

Show summary

active_tenants · integer · required

active_brands · integer · required

healthy_brands · integer · required

pending_count · integer · required

processing_count · integer · required

failed_count · integer · required

dead_letter_count · integer · required

warning_brands · integer · required

critical_brands · integer · required

max_oldest_pending_seconds · integer

max_tenant_event_rate_utilization · number

max_brand_event_rate_utilization · number

max_tenant_inflight_utilization · number

max_brand_inflight_utilization · number

max_parity_mismatch_rate_24h · number · required

items · object[] · required

Show items

tenant_id · string (uuid) · required

tenant_name · string · required

tenant_status · string · required

brand_id · string (uuid) · required

brand_slug · string · required

brand_display_name · string · required

brand_status · string · required

routing_mode · string · required

pending_count · integer · required

processing_count · integer · required

failed_count · integer · required

dead_letter_count · integer · required

oldest_pending_seconds · integer

oldest_failed_seconds · integer

tenant_events_last_minute · integer · required

brand_events_last_minute · integer · required

tenant_inflight_count · integer · required

brand_inflight_count · integer · required

tenant_events_per_minute_limit · integer

brand_events_per_minute_limit · integer

tenant_inflight_limit · integer

brand_inflight_limit · integer

tenant_event_rate_utilization · number

brand_event_rate_utilization · number

tenant_inflight_utilization · number

brand_inflight_utilization · number

parity_mismatch_rate_24h · number · required

health_status · string · required

alerts · string[] · required

limit · integer · required

offset · integer · required

count · integer · required

Status codes

Code	Meaning
200	Dispatch outbox health per brand.
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request GET \
  --url 'https://api.workstream.stateset.com/v1/dispatch/health' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"

200

{
  "generated_at": "2026-08-31T14:22:05Z",
  "window_minutes": 1,
  "summary": {
    "active_tenants": 1,
    "active_brands": 1,
    "healthy_brands": 1,
    "pending_count": 1,
    "processing_count": 1,
    "failed_count": 1,
    "dead_letter_count": 1,
    "warning_brands": 1,
    "critical_brands": 1,
    "max_oldest_pending_seconds": 250,
    "max_tenant_event_rate_utilization": 7.5,
    "max_brand_event_rate_utilization": 7.5,
    "max_tenant_inflight_utilization": 1.5,
    "max_brand_inflight_utilization": 1.5,
    "max_parity_mismatch_rate_24h": 7.5
  },
  "items": [
    {
      "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenant_name": "string",
      "tenant_status": "string",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_slug": "acme-outdoors",
      "brand_display_name": "string",
      "brand_status": "string",
      "routing_mode": "string",
      "pending_count": 1,
      "processing_count": 1,
      "failed_count": 1,
      "dead_letter_count": 1,
      "oldest_pending_seconds": 250,
      "oldest_failed_seconds": 250,
      "tenant_events_last_minute": 1,
      "brand_events_last_minute": 1,
      "tenant_inflight_count": 1,
      "brand_inflight_count": 1,
      "tenant_events_per_minute_limit": 1,
      "brand_events_per_minute_limit": 1,
      "tenant_inflight_limit": 1,
      "brand_inflight_limit": 1,
      "tenant_event_rate_utilization": 7.5,
      "brand_event_rate_utilization": 7.5,
      "tenant_inflight_utilization": 1.5,
      "brand_inflight_utilization": 1.5,
      "parity_mismatch_rate_24h": 7.5,
      "health_status": "string",
      "alerts": []
    }
  ],
  "limit": 20,
  "offset": 1,
  "count": 2
}