Skip to content
Streamkap
Esc
navigateopen⌘Jpreview

Per-topic Kafka metadata for the topics list

Returns per-topic Kafka broker metadata (partition_count, replication_factor, retention_ms) and lastMessageTimestamp, keyed by topic_id.

sources/transforms entities must carry matching topic_ids and topic_db_ids (used for ownership verification); such entities missing topic_db_ids return HTTP 400. destinations are exempt (send topic_db_ids: []) — they are verified against the destination’s topic_map. Topic names must match [a-zA-Z0-9._-]{1,249}; up to 1000 per entity.

All kafka.* fields are nullable — null means the broker did not return metadata for that topic, which is distinct from a legitimate 0. Values may be up to ~60 s stale for partition_count / replication_factor / retention_ms and up to ~10 s stale for lastMessageTimestamp.

POST/topics/table_metrics
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
entitiesSingleTopicTableMetricReq[]required

List of entities (sources/destinations/transforms) with their topic IDs. sources/transforms entities that have topic_ids must also include topic_db_ids for ownership verification; otherwise the request returns HTTP 400. destinations are exempt (send topic_db_ids: []) — they are verified against the destination's topic_map.

Show properties
Array of SingleTopicTableMetricReq
idstringrequired
entity_typestringrequired
connectorstringrequired
topic_idsstring[]required
max items 1000
topic_db_idsstring[]required
max items 1000
Responses
200

Successful Response

object
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 POST "https://api.streamkap.com/topics/table_metrics" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "entities": [
    {
      "id": "string",
      "entity_type": "string",
      "connector": "string",
      "topic_ids": [
        "string"
      ],
      "topic_db_ids": [
        "string"
      ]
    }
  ]
}'
Response
{
  "property1": {
    "id": "string",
    "kafka": {
      "partition_count": 0,
      "replication_factor": 0,
      "retention_ms": 0
    },
    "lastMessageTimestamp": 0,
    "snapshotStatus": [],
    "recordErrorTotal": 0
  },
  "property2": {
    "id": "string",
    "kafka": {
      "partition_count": 0,
      "replication_factor": 0,
      "retention_ms": 0
    },
    "lastMessageTimestamp": 0,
    "snapshotStatus": [],
    "recordErrorTotal": 0
  }
}