Skip to main content
POST
/
dashboard
/
lineage
/
topics
/
batch
Batch fetch topics for multiple entities
curl --request POST \
  --url https://api.streamkap.com/dashboard/lineage/topics/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "group_by": "source",
  "entity_ids": [
    "<string>"
  ],
  "page_size": 20,
  "sort": "byteTotal",
  "sort_dir": "desc",
  "topic_name": "<string>",
  "filter": "<string>",
  "include_metrics": true,
  "global": false,
  "diff_min": 123,
  "diff_max": 123
}
'
{
  "groups": {}
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for POST /dashboard/lineage/topics/batch.

group_by
enum<string>
required

Grouping dimension

Available options:
source,
destination,
transform,
source_audit
entity_ids
string[]
required

Entity IDs to fetch topics for

Required array length: 1 - 100 elements
page_size
integer
default:20

Max topics per entity

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

Sort field for topics

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

Sort direction

Available options:
asc,
desc
topic_name
string | null

Topic name substring filter

filter
string | null

Comma-separated quick filters

include_metrics
boolean
default:true

When false, return metrics as null

global
boolean
default:false

When true, resolve QA counts across services

diff_min
number | null

Min diff% filter (inclusive). Only for source_audit.

diff_max
number | null

Max diff% filter (inclusive). Only for source_audit.

Response

Successful Response

Response for POST /dashboard/lineage/topics/batch.

groups
Groups · object

Topics grouped by entity ID