Skip to main content
GET
/
topics
/
metrics
Get topic metrics
curl --request GET \
  --url https://api.streamkap.com/topics/metrics \
  --header 'Authorization: Bearer <token>'
{
  "timeseries": {
    "byteTotal": [],
    "SnapshotTotalNumberOfEventsSeen": [],
    "StreamingTotalNumberOfCreateEventsSeen": [],
    "StreamingTotalNumberOfDeleteEventsSeen": [],
    "StreamingTotalNumberOfUpdateEventsSeen": [],
    "recordRetryTotal": [],
    "recordSendTotal": []
  },
  "latest": {
    "byteTotal": 123,
    "SnapshotTotalNumberOfEventsSeen": 123,
    "StreamingTotalNumberOfCreateEventsSeen": 123,
    "StreamingTotalNumberOfDeleteEventsSeen": 123,
    "StreamingTotalNumberOfUpdateEventsSeen": 123,
    "recordRetryTotal": 123,
    "recordSendTotal": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

timestamp_to
string | null
timestamp_from
string | null
time_type
string | null
time_interval
integer | null
time_unit
string | null
entity_type
string | null

Filter by entity type. Valid values: sources, transforms. Comma-separated for multiple (e.g., 'sources,transforms').

entity_id
string | null

Filter by specific entity IDs (comma-separated list).

value_format
string | null

Filter by serialization value format. Valid values: avro, json, json_schema, protobuf, string, bytearray. Case-insensitive.

has_errors
boolean | null

Filter topics by error status. true = only topics with recordErrorTotal > 0.

partial_name
string | null

Filter by topic name (partial match).

Response

Successful Response

timeseries
TopicTimeseriesMetrics · object
latest
TopicLatestMetrics · object