Skip to content
Streamkap
Esc
↑↓navigate↵open⌘Jpreview

Get dashboard health summary

Returns a high-level health overview including broken connectors, failed transforms, active snapshots, and topic health metrics.

GET/dashboard/health
Authorization
AuthorizationBearer token · headerrequired
Responses
200

Successful Response

sources_brokeninteger

Number of broken source connectors

default: 0
destinations_brokeninteger

Number of broken destination connectors

default: 0
transforms_failedinteger

Number of failed transforms

default: 0
failed_transform_idsstring[]

Entity IDs of failed transforms

pipelines_brokeninteger

Number of broken pipelines

default: 0
broken_pipelinesBrokenPipelineRes[]

The pipelines counted in pipelines_broken

Show properties
Array of BrokenPipelineRes
idstringrequired

Pipeline entity ID

namestringrequired

Pipeline display name

dlq_topics_with_messagesinteger

Number of DLQ topics currently retaining messages (from Kafka offsets, same count as GET /dashboard/dlq total_with_messages)

default: 0
orphaned_topic_countinteger

Number of orphaned topics

default: 0
stale_source_countinteger

Number of stale sources with no recent data

default: 0
partition_skew_countinteger

Number of topics with partition skew

default: 0
throughput_total_rpsnumber

Total throughput in records per second

default: 0
broken_connectorsBrokenConnectorRes[]

List of broken connectors

Show properties
Array of BrokenConnectorRes
idstringrequired

Connector entity ID

namestringrequired

Connector display name

typestringrequired

Connector type: 'source' or 'destination'

sources_throttledinteger

Number of api sources waiting out their vendor's rate budget. They resume by themselves, so they are counted apart from sources_broken.

default: 0
throttled_connectorsBrokenConnectorRes[]

The sources counted in sources_throttled

Show properties
Array of BrokenConnectorRes
idstringrequired

Connector entity ID

namestringrequired

Connector display name

typestringrequired

Connector type: 'source' or 'destination'

active_snapshotsActiveSnapshotRes[]

List of sources with active snapshots

Show properties
Array of ActiveSnapshotRes
source_idstringrequired

Source entity ID

source_namestringrequired

Source display name

topic_countinteger

Total number of topics in the snapshot

default: 0
completed_countinteger

Number of topics that have completed snapshotting

default: 0
topic_healthTopicHealthRes

Aggregated topic health metrics

Show properties
topics_high_latencyinteger

Number of topics with high latency

default: 0
topics_with_laginteger

Number of topics whose consumer lag exceeds the high-lag threshold (HIGH_LAG_THRESHOLD).

default: 0
max_latency_msinteger

Maximum latency across all topics in milliseconds

default: 0
max_laginteger

Maximum consumer lag across all topics

default: 0
Request
curl -X GET 'https://api.streamkap.com/dashboard/health' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "sources_broken": 0,
  "destinations_broken": 0,
  "transforms_failed": 0,
  "failed_transform_ids": [
    "string"
  ],
  "pipelines_broken": 0,
  "broken_pipelines": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "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"
    }
  ],
  "sources_throttled": 0,
  "throttled_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
  }
}