Skip to main content
GET
/
admin
/
v1
/
topics
/
{topicName}
/
messages
Get messages from a topic
curl --request GET \
  --url https://api.example.com/admin/v1/topics/{topicName}/messages
[
  {
    "type": "PHASE",
    "message": {
      "partition": 123,
      "offset": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "timestampType": "NO_TIMESTAMP_TYPE",
      "key": "<string>",
      "headers": {},
      "content": "<string>",
      "keyFormat": "AVRO",
      "valueFormat": "AVRO",
      "keySize": 123,
      "valueSize": 123,
      "keySchemaId": "<string>",
      "valueSchemaId": "<string>",
      "headersSize": 123,
      "keySerde": "<string>",
      "valueSerde": "<string>",
      "keyDeserializeProperties": {},
      "valueDeserializeProperties": {}
    },
    "phase": {
      "name": "<string>"
    },
    "consuming": {
      "bytesConsumed": 123,
      "elapsedMs": 123,
      "isCancelled": true,
      "messagesConsumed": 123,
      "filterApplyErrors": 123
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.streamnative.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
topicName
string
required

Topic name

Query Parameters

​
seekType
enum<string>

Seek type

Available options:
BEGINNING,
OFFSET,
TIMESTAMP,
LATEST
​
seekTo
string[]

The format is [partition]::[offset] for specifying offsets or [partition]::[timestamp in millis] for specifying timestamps

​
limit
integer<int32>

Limit

​
q
string

Query

​
keySerde
string

Serde that should be used for deserialization. Supports String, Base64, Hex, SchemaRegistry, ProtobufDecodeRaw, and Avro (Embedded)

​
valueSerde
string

Serde that should be used for deserialization. Supports String, Base64, Hex, SchemaRegistry, ProtobufDecodeRaw, and Avro (Embedded)

Response

OK

​
type
enum<string>
Available options:
PHASE,
MESSAGE,
CONSUMING,
DONE,
EMIT_THROTTLING
​
message
object
​
phase
object
​
consuming
object