> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get dispatch health dashboard

> Dispatch outbox health per brand.

### Response

`object`

<ResponseField name="generated_at" type="string (date-time)" required />

<ResponseField name="window_minutes" type="integer" required />

<ResponseField name="summary" type="object" required>
  <Expandable title="summary">
    <ResponseField name="active_tenants" type="integer" required />

    <ResponseField name="active_brands" type="integer" required />

    <ResponseField name="healthy_brands" type="integer" required />

    <ResponseField name="pending_count" type="integer" required />

    <ResponseField name="processing_count" type="integer" required />

    <ResponseField name="failed_count" type="integer" required />

    <ResponseField name="dead_letter_count" type="integer" required />

    <ResponseField name="warning_brands" type="integer" required />

    <ResponseField name="critical_brands" type="integer" required />

    <ResponseField name="max_oldest_pending_seconds" type="integer" />

    <ResponseField name="max_tenant_event_rate_utilization" type="number" />

    <ResponseField name="max_brand_event_rate_utilization" type="number" />

    <ResponseField name="max_tenant_inflight_utilization" type="number" />

    <ResponseField name="max_brand_inflight_utilization" type="number" />

    <ResponseField name="max_parity_mismatch_rate_24h" type="number" required />
  </Expandable>
</ResponseField>

<ResponseField name="items" type="object[]" required>
  <Expandable title="items">
    <ResponseField name="tenant_id" type="string (uuid)" required />

    <ResponseField name="tenant_name" type="string" required />

    <ResponseField name="tenant_status" type="string" required />

    <ResponseField name="brand_id" type="string (uuid)" required />

    <ResponseField name="brand_slug" type="string" required />

    <ResponseField name="brand_display_name" type="string" required />

    <ResponseField name="brand_status" type="string" required />

    <ResponseField name="routing_mode" type="string" required />

    <ResponseField name="pending_count" type="integer" required />

    <ResponseField name="processing_count" type="integer" required />

    <ResponseField name="failed_count" type="integer" required />

    <ResponseField name="dead_letter_count" type="integer" required />

    <ResponseField name="oldest_pending_seconds" type="integer" />

    <ResponseField name="oldest_failed_seconds" type="integer" />

    <ResponseField name="tenant_events_last_minute" type="integer" required />

    <ResponseField name="brand_events_last_minute" type="integer" required />

    <ResponseField name="tenant_inflight_count" type="integer" required />

    <ResponseField name="brand_inflight_count" type="integer" required />

    <ResponseField name="tenant_events_per_minute_limit" type="integer" />

    <ResponseField name="brand_events_per_minute_limit" type="integer" />

    <ResponseField name="tenant_inflight_limit" type="integer" />

    <ResponseField name="brand_inflight_limit" type="integer" />

    <ResponseField name="tenant_event_rate_utilization" type="number" />

    <ResponseField name="brand_event_rate_utilization" type="number" />

    <ResponseField name="tenant_inflight_utilization" type="number" />

    <ResponseField name="brand_inflight_utilization" type="number" />

    <ResponseField name="parity_mismatch_rate_24h" type="number" required />

    <ResponseField name="health_status" type="string" required />

    <ResponseField name="alerts" type="string[]" required />
  </Expandable>
</ResponseField>

<ResponseField name="limit" type="integer" required />

<ResponseField name="offset" type="integer" required />

<ResponseField name="count" type="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                    |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.workstream.stateset.com/v1/dispatch/health' \
    --header "x-api-key: $STATESET_TEMPORAL_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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
  }
  ```
</ResponseExample>