STstreamkap
Dashboard

Get dashboard lineage topics

Changed on

Returns detailed topic-level lineage information including source, transforms, destinations, and per-topic metrics. Supports filtering and pagination.

get/dashboard/lineage/topics

Request

Query parameters

source_idstring nullable

Filter by source entity ID

destination_idstring nullable

Filter by destination entity ID

transform_idstring nullable

Filter by transform entity ID

topic_namestring nullable

Filter by topic name (substring match)

topic_idstring nullable

Filter by full topic name (exact match). Used by the per-topic lineage view.

filterstring nullable

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

include_dlqboolean

When false, exclude DLQ topics

snapshotstring nullable

Comma-separated snapshot status filter matched against each table's own status: running, pending, completed, completed_with_warnings, failed, cancelled, paused.

pageinteger

Page number (1-indexed)

page_sizeinteger

Results per page

sort'byteTotal' | 'latency' | 'speed' | 'lag' | 'name'

Sort field

sort_dir'asc' | 'desc'

Sort direction

include_metricsboolean

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

Response

Successful Response

pageinteger

Current page number

page_sizeinteger

Results per page

totalinteger nullable

Total number of results

has_nextboolean nullable

Whether more pages exist

Changes

  • e52ab3a4b1f0Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • 8d6969228b4eRevision changes
    • info

      added the new optional query request parameter topic_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status