Skip to main content
GET
/
dashboard
/
lineage
Get dashboard lineage groups
curl --request GET \
  --url https://api.streamkap.com/dashboard/lineage \
  --header 'Authorization: Bearer <token>'
{
  "page": 1,
  "page_size": 10,
  "total": 123,
  "has_next": true,
  "result": [
    {
      "id": "<string>",
      "entity_id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "connector": "",
      "status": "",
      "topic_count": 0,
      "total_topic_count": 0,
      "metrics": {
        "max_latency_ms": 0,
        "total_speed_rps": 0,
        "total_lag": 0,
        "topic_count": 0,
        "error_count": 0
      },
      "snapshot_progress": {
        "state": "<string>",
        "snapshot_type": "incremental",
        "total_table_count": 0,
        "remaining_table_count": 0,
        "percent_complete": 0,
        "eta_ms": 0,
        "start_timestamp": "<string>",
        "end_timestamp": "<string>"
      },
      "topics": {
        "result": [
          {
            "id": "<string>",
            "name": "<string>",
            "source": {
              "id": "<string>",
              "name": "<string>",
              "connector": "",
              "snapshot_progress": {
                "state": "<string>",
                "snapshot_type": "incremental",
                "total_table_count": 0,
                "remaining_table_count": 0,
                "percent_complete": 0,
                "eta_ms": 0,
                "start_timestamp": "<string>",
                "end_timestamp": "<string>"
              }
            },
            "metrics": {
              "StreamingMilliSecondsBehindSource": 0,
              "SnapshotPercentageComplete": 0,
              "recordSendTotal": 0,
              "sourceRecordWriteTotal": 0,
              "snapshotPercentageComplete": 0,
              "recordsLag": 0,
              "byteTotal": 0,
              "sourceRecordPollRate": 0,
              "sourceQaCount": 123
            },
            "snapshot_status": "<string>",
            "snapshot_details": [
              {
                "status": "<string>",
                "start_timestamp": "<string>",
                "end_timestamp": "<string>",
                "duration_ms": 123,
                "rows_scanned": 0,
                "rows_total": 0,
                "trace": "<string>",
                "eta_ms": 0
              }
            ],
            "transforms": [
              {
                "id": "<string>",
                "name": "<string>",
                "status": "",
                "metrics": {
                  "latency": 0
                },
                "output_topics": [
                  "<string>"
                ],
                "transform_type": "fan_out",
                "destinations": [
                  {
                    "id": "<string>",
                    "name": "<string>",
                    "connector": "",
                    "pipeline_id": "",
                    "pipeline_status": "",
                    "lag": 123,
                    "qaCount": 123,
                    "e2e_eta_ms": 123
                  }
                ]
              }
            ],
            "destinations": [
              {
                "id": "<string>",
                "name": "<string>",
                "connector": "",
                "pipeline_id": "",
                "pipeline_status": "",
                "lag": 123,
                "qaCount": 123,
                "e2e_eta_ms": 123
              }
            ]
          }
        ],
        "total": 0,
        "page": 1,
        "has_next": false
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
group_by
enum<string>
default:source

Group lineage by entity type

Available options:
source,
destination,
transform,
source_audit
​
search
string | null

Search filter for group names

​
sort
enum<string> | null

Sort field for lineage groups Sort field values for the lineage groups endpoint.

Available options:
name,
topic_count,
max_latency,
total_speed,
error_count
​
sort_dir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
page_size
integer
default:10

Results per page

Required range: 1 <= x <= 100
​
include_metrics
boolean
default:true

When false, skip ClickHouse metrics and return metrics as null for faster initial render

​
topic_name
string | null

Filter groups to those with matching topics (substring, case-insensitive)

​
source_ids
string | null

Comma-separated source entity IDs to filter groups by

​
destination_ids
string | null

Comma-separated destination entity IDs to filter groups by

​
transform_ids
string | null

Comma-separated transform entity IDs to filter groups by

​
global
boolean
default:false

When true, resolve QA counts across services (multi-hop pipelines)

​
include_topics
boolean
default:false

When true, embed first page of enriched topics in each group

​
topics_page_size
integer
default:20

Max topics to embed per group

Required range: 1 <= x <= 100
​
topics_sort
enum<string>
default:byteTotal

Sort field for embedded topics

Available options:
byteTotal,
latency,
speed,
lag,
name
​
topics_sort_dir
enum<string>
default:desc

Sort direction for embedded topics

Available options:
asc,
desc

Response

Successful Response

Response model for GET /dashboard/lineage.

​
page
integer
default:1

Current page number

​
page_size
integer
default:10

Results per page

​
total
integer | null

Total number of results

​
has_next
boolean | null

Whether more pages exist

​
result
LineageGroupRes · object[]

List of lineage groups