List all topics

GET/topics/details

Authorization

AuthorizationBearer token · headerrequired

Query parameters

entity_typestring | any

Filter by entity type(s). Single value (e.g., 'sources') or comma-separated (e.g., 'sources,transforms'). Valid types: sources, destinations, transforms, pipelines, manual.

topic_idstring | any

partial_namestring | any

Topic id

pageinteger

default: 1

page_sizeinteger

default: 10

entity_idstring | any

Filter by specific entity IDs (comma-separated list)

include_dlqboolean

Include Dead Letter Queue (DLQ) topics in results. Set to false to exclude DLQ topics.

default: true

include_internalboolean

Local/admin-app only: include Streamkap/KC internal topics (streamkap_signal, streamkap_state, KC offsets/configs/status) in the result. Internal topics carry connector='internal:<klass>'.

default: false

snapshotstring | any

Filter topics by snapshot status. Comma-separated for multiple statuses (e.g., 'running', 'completed,failed'). Valid statuses: running, completed, failed, pending, cancelled

etastring | any

Filter by snapshot ETA in milliseconds. Format: 'operator:value' (e.g., 'gt:60000', 'lte:300000'). Valid operators: gt (>), lt (<), gte (>=), lte (<=), eq (=), ne (!=). Topics without ETA (null/0) are excluded when filtering.

timestamp_fromstring | any

Start timestamp for filtering topics by activity period (ISO 8601 format)

timestamp_tostring | any

End timestamp for filtering topics by activity period (ISO 8601 format)

time_typestring | any

Time aggregation type for filtering active topics (only applies when timestamp_from/to are specified)

value_formatstring | any

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Omit or pass null to return all formats.

has_errorsboolean | any

Filter topics by error status. true = only topics with recordErrorTotal > 0, false = only topics with recordErrorTotal == 0, null/omit = return all topics.

orphanedboolean | any

Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations.

partition_skewboolean | any

Filter by partition skew. true = only topics where max partition lag > 2x average.

sortstring | any

Sort field. Valid values: DB fields (name, connector, entity_type, entity_name), snapshot_status (sources only), or Kafka-admin fields (partition_count, replication_factor, retention_ms, lastMessageTimestamp).

sort_dirstring

default: "asc"

Allowed:ascdesc

tag_idsstring | any

Filter by tag IDs. Comma-separated list (e.g., 'tag1,tag2'). Use with tag_filter_operation to control AND/OR logic.

tag_filter_operationstring | any

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags.

default: "or"

Request body

application/json

Any of:

TopicDetailsReqBody

entity_idstring[] | string | any

List of entity IDs (as array) or comma-separated string. Body takes precedence over query params.

Show properties

Any of:

string[]

Array of string

string

string

string

any

any

snapshotstring[] | string | any

List of snapshot statuses (as array) or comma-separated string. Body takes precedence over query params. Valid statuses: running, completed, failed, pending, cancelled

Show properties

Any of:

string[]

Array of string

string

string

string

any

any

value_formatstring | any

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Body takes precedence over query params.

Show properties

Any of:

string

string

any

any

has_errorsboolean | any

Filter topics by error status. true = only topics with errors, false = only topics without errors. Body takes precedence over query params.

Show properties

Any of:

boolean

boolean

any

any

orphanedboolean | any

Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations. Body takes precedence over query params.

Show properties

Any of:

boolean

boolean

any

any

partition_skewboolean | any

Filter by partition skew. true = only topics where max partition lag > 2x average. Body takes precedence over query params.

Show properties

Any of:

boolean

boolean

any

any

tag_idsstring[] | string | any

List of tag IDs (as array) or comma-separated string. Body takes precedence over query params.

Show properties

Any of:

string[]

Array of string

string

string

string

any

any

tag_filter_operationstring | any

Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags. Body takes precedence over query params.

Show properties

Any of:

string

string

any

any

any

any

Responses

200

Successful Response

pageinteger

Current page number

default: 1

page_sizeinteger

Results per page

default: 10

totalinteger | any

Total number of results

Show properties

Any of:

integer

integer

any

any

has_nextboolean | any

Whether more pages exist

Show properties

Any of:

boolean

boolean

any

any

resultTopicDetailsRes[]required

Show properties

Array of TopicDetailsRes

idstringrequired

namestringrequired

entityTopicDetailsEntityrequired

Show properties

entity_typeTopicDetailsEntityTypeEnumrequired

Enum for topic entity types (producer types).

Allowed:sourcesdestinationstransformspipelinesmanual

entity_idstringrequired

namestringrequired

connectorSourceConnectorEnum | DestinationConnectorEnum | TransformsLibraryEnum | stringrequired

Show properties

Any of:

SourceConnectorEnum

string

DestinationConnectorEnum

string

TransformsLibraryEnum

string

string

string

topic_idsstring[]required

topic_db_idsstring[]required

display_namestringrequired

filtered_snapshot_languagestring | any

Show properties

Any of:

string

string

any

any

prefixstring | any

Show properties

Any of:

string

string

any

any

serializationTopicSerialization | any

Serialization format information for this topic (inherited from producer)

Show properties

Any of:

TopicSerialization

key_formatSerializationFormatEnum

Human-readable serialization format names for API responses.

Allowed:avrojsonjson_schemaprotobufstringbytearrayunknown

value_formatSerializationFormatEnum

Human-readable serialization format names for API responses.

Allowed:avrojsonjson_schemaprotobufstringbytearrayunknown

key_converterstring | any

Converter class for message keys

Show properties

Any of:

string

string

any

any

value_converterstring | any

Converter class for message values

Show properties

Any of:

string

string

any

any

schema_registry_enabledboolean

Whether Schema Registry is used for this topic's serialization

default: false

any

any

tagsstring[] | any

List of tag IDs assigned to this topic

Show properties

Any of:

string[]

Array of string

string

any

any

broker_onlyboolean

True when this row was surfaced from a broker listing rather than the MongoDB topics collection (only possible with include_internal=true). The FE renders a badge so the user can tell Mongo-tracked topics apart from broker-only ones.

default: false

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "https://api.streamkap.com/topics/details" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_id": [
    "string"
  ],
  "snapshot": [
    "string"
  ],
  "value_format": "string",
  "has_errors": true,
  "orphaned": true,
  "partition_skew": true,
  "tag_ids": [
    "string"
  ],
  "tag_filter_operation": "and"
}'

const response = await fetch("https://api.streamkap.com/topics/details", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"entity_id\": [\n    \"string\"\n  ],\n  \"snapshot\": [\n    \"string\"\n  ],\n  \"value_format\": \"string\",\n  \"has_errors\": true,\n  \"orphaned\": true,\n  \"partition_skew\": true,\n  \"tag_ids\": [\n    \"string\"\n  ],\n  \"tag_filter_operation\": \"and\"\n}"
});

import requests

response = requests.get(
    "https://api.streamkap.com/topics/details",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"entity_id\": [\n    \"string\"\n  ],\n  \"snapshot\": [\n    \"string\"\n  ],\n  \"value_format\": \"string\",\n  \"has_errors\": true,\n  \"orphaned\": true,\n  \"partition_skew\": true,\n  \"tag_ids\": [\n    \"string\"\n  ],\n  \"tag_filter_operation\": \"and\"\n}",
)

Response

{
  "page": 1,
  "page_size": 10,
  "total": 0,
  "has_next": true,
  "result": [
    {
      "id": "string",
      "name": "string",
      "entity": {
        "entity_type": "sources",
        "entity_id": "string",
        "name": "string",
        "connector": "alloydb",
        "topic_ids": [
          "string"
        ],
        "topic_db_ids": [
          "string"
        ],
        "display_name": "string",
        "filtered_snapshot_language": "string"
      },
      "prefix": "string",
      "serialization": {
        "key_format": "avro",
        "value_format": "avro",
        "key_converter": "string",
        "value_converter": "string",
        "schema_registry_enabled": false
      },
      "tags": [
        "string"
      ],
      "broker_only": false
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}