Skip to main content
GET
/
dashboard
/
health
Get dashboard health summary
curl --request GET \
  --url https://api.streamkap.com/dashboard/health \
  --header 'Authorization: Bearer <token>'
{
  "sources_broken": 0,
  "destinations_broken": 0,
  "transforms_failed": 0,
  "failed_transform_ids": [
    "<string>"
  ],
  "pipelines_broken": 0,
  "dlq_topics_with_messages": 0,
  "orphaned_topic_count": 0,
  "stale_source_count": 0,
  "partition_skew_count": 0,
  "throughput_total_rps": 0,
  "broken_connectors": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "active_snapshots": [
    {
      "source_id": "<string>",
      "source_name": "<string>",
      "topic_count": 0,
      "completed_count": 0
    }
  ],
  "topic_health": {
    "topics_high_latency": 0,
    "topics_with_lag": 0,
    "max_latency_ms": 0,
    "max_lag": 0
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Response model for GET /dashboard/health.

sources_broken
integer
default:0

Number of broken source connectors

destinations_broken
integer
default:0

Number of broken destination connectors

transforms_failed
integer
default:0

Number of failed transforms

failed_transform_ids
string[]

Entity IDs of failed transforms

pipelines_broken
integer
default:0

Number of broken pipelines

dlq_topics_with_messages
integer
default:0

Number of DLQ topics containing messages

orphaned_topic_count
integer
default:0

Number of orphaned topics

stale_source_count
integer
default:0

Number of stale sources with no recent data

partition_skew_count
integer
default:0

Number of topics with partition skew

throughput_total_rps
number
default:0

Total throughput in records per second

broken_connectors
BrokenConnectorRes · object[]

List of broken connectors

active_snapshots
ActiveSnapshotRes · object[]

List of sources with active snapshots

topic_health
TopicHealthRes · object

Aggregated topic health metrics