curl --request GET \
--url https://api.streamkap.com/dashboard/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.streamkap.com/dashboard/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.streamkap.com/dashboard/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.streamkap.com/dashboard/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.streamkap.com/dashboard/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.streamkap.com/dashboard/health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.streamkap.com/dashboard/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
}Get dashboard health summary
Returns a high-level health overview including broken connectors, failed transforms, active snapshots, and topic health metrics.
curl --request GET \
--url https://api.streamkap.com/dashboard/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.streamkap.com/dashboard/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.streamkap.com/dashboard/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.streamkap.com/dashboard/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.streamkap.com/dashboard/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.streamkap.com/dashboard/health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.streamkap.com/dashboard/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Successful Response
Response model for GET /dashboard/health.
Number of broken source connectors
Number of broken destination connectors
Number of failed transforms
Entity IDs of failed transforms
Number of broken pipelines
Number of DLQ topics containing messages
Number of orphaned topics
Number of stale sources with no recent data
Number of topics with partition skew
Total throughput in records per second
List of broken connectors
Show child attributes
Show child attributes
List of sources with active snapshots
Show child attributes
Show child attributes
Aggregated topic health metrics
Show child attributes
Show child attributes
Was this page helpful?