Skip to main content
GET
Get dashboard lineage groups

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

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
diff_min
number | null

Min diff% for topic filtering (audit tab)

diff_max
number | null

Max diff% for topic filtering (audit tab)

latency
string | null

Filter groups by max_latency_ms using "op:value" syntax (e.g. "gt:300000"). Ops: gt|gte|lt|lte|eq|ne.

lag
string | null

Filter groups by total_lag using "op:value" syntax (e.g. "gt:1000"). Ops: gt|gte|lt|lte|eq|ne.

snapshot
string | null

Filter groups by snapshot state. Comma-separated list: running|pending|completed|failed|not_started.

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