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

List DLQ topics and their current size

Returns the tenant’s Dead Letter Queue topics (source, destination and transform DLQs) with the number of messages each one currently retains, read from Kafka offsets. By default only DLQ topics holding messages are returned.

GET/dashboard/dlq
Authorization
AuthorizationBearer token · headerrequired
Query parameters
include_emptyboolean

Also return DLQ topics with no messages

default: false
searchstring

Substring match on topic name or owner name

pageinteger

Page number (1-indexed)

min 1 · default: 1
page_sizeinteger

Results per page

min 1 · max 100 · default: 50
sortDlqSortEnum

Sort field

Allowed:message_countnameowner
sort_dirstring

Sort direction

default: "desc"
Allowed:ascdesc
include_last_messageboolean

Also fetch each returned topic's newest-message timestamp (slower: polls Kafka)

default: false
Responses
200

Successful Response

pageinteger

Current page number

default: 1
page_sizeinteger

Results per page

default: 10
totalinteger | null

Total number of results

Show properties
Any of:
integer
integer
null
null
has_nextboolean | null

Whether more pages exist

Show properties
Any of:
boolean
boolean
null
null
resultDlqTopicRes[]

DLQ topics for this page

Show properties
Array of DlqTopicRes
topic_idstringrequired

Topic id, as used by the topic details page

owner_typeDlqOwnerTypeEnumrequired

Entity that writes to a DLQ topic.

Allowed:sourcedestinationtransformunknown
owner_idstring | null

Source, destination or transform entity ID

Show properties
Any of:
string
string
null
null
owner_namestring | null

Source, destination or transform display name

Show properties
Any of:
string
string
null
null
owner_connectorstring | null

Source/destination connector or transform type

Show properties
Any of:
string
string
null
null
message_countinteger

Messages currently retained (sum of end - start offsets)

default: 0
partition_countinteger

Partitions on the broker; 0 if the topic is missing

default: 0
last_message_atinteger | null

Epoch ms of the newest message; null unless include_last_message=true

Show properties
Any of:
integer
integer
null
null
total_with_messagesinteger

DLQ topics retaining at least one message

default: 0
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/dashboard/dlq' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "page": 1,
  "page_size": 10,
  "total": 0,
  "has_next": true,
  "result": [
    {
      "topic_id": "string",
      "owner_type": "source",
      "owner_id": "string",
      "owner_name": "string",
      "owner_connector": "string",
      "message_count": 0,
      "partition_count": 0,
      "last_message_at": 0
    }
  ],
  "total_with_messages": 0
}