Search topics (POST)
Changed onPOST alternative for GET /topics/details. Use when URL length limits are exceeded (e.g., 100+ entity IDs). Supports both query parameters and request body. Body parameters take precedence over query parameters.
Request
- Base URLhttps://api.streamkap.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Filter by entity type(s). Single value (e.g., 'sources') or comma-separated (e.g., 'sources,transforms'). Valid types: sources, destinations, transforms, pipelines, manual, agents. Types given alongside entity_id but owning none of those IDs (e.g. 'agents', which has no picker) match on type alone rather than being AND-ed against the ID list.
Topic id
Filter by specific entity IDs (comma-separated list)
Narrow the result to topics DELIVERED to these destinations (comma-separated). Orthogonal to entity_type/entity_id, which select the topics' PRODUCER: combining the two expresses 'produced by these sources and delivered to these destinations'. Distinct from entity_type=destinations, which answers 'the topics this destination consumes' on its own.
Include Dead Letter Queue (DLQ) topics in results. Set to false to exclude DLQ topics.
Include Streamkap and Kafka Connect internal topics (signal, state, and Kafka Connect offsets/configs/status) in the result; they carry connector='internal:<klass>'. Not available to regular tenant API calls: setting it returns 403.
Filter topics by snapshot status. Comma-separated for multiple statuses (e.g., 'running', 'completed,failed'). Valid statuses: running, completed, failed, pending, cancelled, completed_with_warnings
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.
Start timestamp for filtering topics by activity period (ISO 8601 format)
End timestamp for filtering topics by activity period (ISO 8601 format)
Time aggregation type for filtering active topics (only applies when timestamp_from/to are specified)
Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive. Omit or pass null to return all formats.
Filter topics by error status. true = only topics with recordErrorTotal > 0, false = only topics with recordErrorTotal == 0, null/omit = return all topics.
Filter by orphaned status. true = only topics with 0 destinations, false = only topics with destinations.
Filter by partition skew. true = only topics where max partition lag > 2x average.
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).
Filter by tag IDs. Comma-separated list (e.g., 'tag1,tag2'). Use with tag_filter_operation to control AND/OR logic.
Tag filter logic: 'or' (default) matches any tag, 'and' matches all tags.
Request body
Response
Successful Response
Changes
- warning
added the new
freshdeskenum value to the////response property for the response status - warning
added the new
pipedriveenum value to the////response property for the response status - warning
added the new
shopifyenum value to the////response property for the response status
- warning
- warning
added the new
agentsenum value to the///response property for the response status - warning
added the new
facebook_adsenum value to the////response property for the response status - warning
added the new
google_adsenum value to the////response property for the response status - warning
added the new
google_analyticsenum value to the////response property for the response status - warning
added the new
hubspotenum value to the////response property for the response status - warning
added the new
netsuiteenum value to the////response property for the response status - warning
added the new
salesforceenum value to the////response property for the response status - warning
added the new
stripeenum value to the////response property for the response status - warning
added the new
zendeskenum value to the////response property for the response status
- warning