STstreamkap
Dashboard

Get dashboard lineage groups

Changed on

Returns lineage groups (sources, destinations, or transforms) with aggregated metrics. Use the group_by parameter to select the grouping dimension.

get/dashboard/lineage

Request

Query parameters

group_by'source' | 'destination' | 'transform' | 'source_audit'

Group lineage by entity type

searchstring nullable

Search filter for group names

sort'name' | 'topic_count' | 'max_latency' | 'total_speed' | 'error_count'

Sort field values for the lineage groups endpoint.

Sort field for lineage groups

sort_dir'asc' | 'desc'

Sort direction

pageinteger

Page number (1-indexed)

page_sizeinteger

Results per page

include_metricsboolean

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

topic_namestring nullable

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

source_idsstring nullable

Comma-separated source entity IDs to filter groups by

destination_idsstring nullable

Comma-separated destination entity IDs to filter groups by

transform_idsstring nullable

Comma-separated transform entity IDs to filter groups by

include_topicsboolean

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

topics_page_sizeinteger

Max topics to embed per group

topics_sort'byteTotal' | 'latency' | 'speed' | 'lag' | 'name'

Sort field for embedded topics

topics_sort_dir'asc' | 'desc'

Sort direction for embedded topics

diff_bandsstring nullable

Comma-separated diff% bands for topic filtering (audit tab). Each band is 'min-max' (inclusive). Multi-select: topic passes if its rounded-to-2-decimals max diff% falls in ANY band. Example: '0-0.05,2-10'.

latencystring nullable

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

lagstring nullable

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

snapshotstring nullable

Filter by snapshot status, per table. A group is kept when at least one of its tables matches, and only the matching tables are returned. Comma-separated list: running|pending|completed|completed_with_warnings|failed|cancelled|paused.

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

    • info

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

  • 8d6969228b4eRevision 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