Skip to main content
GET
Get dashboard lineage topics

Authorizations

Authorization
string
header
required

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

Query Parameters

source_id
string | null

Filter by source entity ID

destination_id
string | null

Filter by destination entity ID

transform_id
string | null

Filter by transform entity ID

topic_name
string | null

Filter by topic name (substring match)

filter
string | null

Comma-separated topic filters: has_destination, orphaned, has_transform, dlq, snapshotting

include_dlq
boolean
default:true

When false, exclude DLQ topics

snapshot
string | null

Comma-separated snapshot status filter: running, completed, pending

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
page_size
integer
default:5

Results per page

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

Sort field

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

Sort direction

Available options:
asc,
desc
include_metrics
boolean
default:true

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

Response

Successful Response

Response model for GET /dashboard/lineage/topics.

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
LineageTopicRes · object[]

List of topics with lineage info