Skip to content
Streamkap
Esc
↑↓navigate↵open⌘Jpreview

Get topic metrics

GET/topics/metrics
Authorization
AuthorizationBearer token · headerrequired
Query parameters
timestamp_tostring
timestamp_fromstring
time_typestring
time_intervalinteger
time_unitstring
entity_typestring

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

entity_idstring

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

value_formatstring

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

has_errorsboolean

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

partial_namestring

Filter by topic name (partial match).

Responses
200

Successful Response

timeseriesTopicTimeseriesMetrics | null
Show properties
Any of:
TopicTimeseriesMetrics
byteTotalTimeseriesEntry[]
default: []
Show properties
Array of TimeseriesEntry
valueinteger | numberrequired

The metric value at this timestamp

Show properties
Any of:
integer
integer
number
number
timestampstringrequired

ISO 8601 timestamp for this data point

SnapshotTotalNumberOfEventsSeenTimeseriesEntry[]
default: []
Show properties
Array of TimeseriesEntry
valueinteger | numberrequired

The metric value at this timestamp

Show properties
Any of:
integer
integer
number
number
timestampstringrequired

ISO 8601 timestamp for this data point

StreamingTotalNumberOfCreateEventsSeenTimeseriesEntry[]
default: []
Show properties
Array of TimeseriesEntry
valueinteger | numberrequired

The metric value at this timestamp

Show properties
Any of:
integer
integer
number
number
timestampstringrequired

ISO 8601 timestamp for this data point

StreamingTotalNumberOfDeleteEventsSeenTimeseriesEntry[]
default: []
Show properties
Array of TimeseriesEntry
valueinteger | numberrequired

The metric value at this timestamp

Show properties
Any of:
integer
integer
number
number
timestampstringrequired

ISO 8601 timestamp for this data point

StreamingTotalNumberOfUpdateEventsSeenTimeseriesEntry[]
default: []
Show properties
Array of TimeseriesEntry
valueinteger | numberrequired

The metric value at this timestamp

Show properties
Any of:
integer
integer
number
number
timestampstringrequired

ISO 8601 timestamp for this data point

recordRetryTotalTimeseriesEntry[]
default: []
Show properties
Array of TimeseriesEntry
valueinteger | numberrequired

The metric value at this timestamp

Show properties
Any of:
integer
integer
number
number
timestampstringrequired

ISO 8601 timestamp for this data point

recordSendTotalTimeseriesEntry[]
default: []
Show properties
Array of TimeseriesEntry
valueinteger | numberrequired

The metric value at this timestamp

Show properties
Any of:
integer
integer
number
number
timestampstringrequired

ISO 8601 timestamp for this data point

null
null
latestTopicLatestMetrics | null
Show properties
Any of:
TopicLatestMetrics
byteTotalinteger | number | null
Show properties
Any of:
integer
integer
number
number
null
null
SnapshotTotalNumberOfEventsSeeninteger | number | null
Show properties
Any of:
integer
integer
number
number
null
null
StreamingTotalNumberOfCreateEventsSeeninteger | number | null
Show properties
Any of:
integer
integer
number
number
null
null
StreamingTotalNumberOfDeleteEventsSeeninteger | number | null
Show properties
Any of:
integer
integer
number
number
null
null
StreamingTotalNumberOfUpdateEventsSeeninteger | number | null
Show properties
Any of:
integer
integer
number
number
null
null
recordRetryTotalinteger | number | null
Show properties
Any of:
integer
integer
number
number
null
null
recordSendTotalinteger | number | null
Show properties
Any of:
integer
integer
number
number
null
null
null
null
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/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "timeseries": {
    "byteTotal": [],
    "SnapshotTotalNumberOfEventsSeen": [],
    "StreamingTotalNumberOfCreateEventsSeen": [],
    "StreamingTotalNumberOfDeleteEventsSeen": [],
    "StreamingTotalNumberOfUpdateEventsSeen": [],
    "recordRetryTotal": [],
    "recordSendTotal": []
  },
  "latest": {
    "byteTotal": 0,
    "SnapshotTotalNumberOfEventsSeen": 0,
    "StreamingTotalNumberOfCreateEventsSeen": 0,
    "StreamingTotalNumberOfDeleteEventsSeen": 0,
    "StreamingTotalNumberOfUpdateEventsSeen": 0,
    "recordRetryTotal": 0,
    "recordSendTotal": 0
  }
}