Get records from a topic.

GET /topics/{topic_name}/partitions/{partition_id}/records

Path parameters

  • topic_name string Required
  • partition_id integer Required

Query parameters

  • offset integer Required
  • timeout integer Required
  • max_bytes integer Required

Responses

  • Hide response attribute Show response attribute object
    • records array[object]
      Hide records attributes Show records attributes object
      • topic string
      • key string
      • value string
      • partition integer
      • offset integer
    Hide response attribute Show response attribute object
    • records array[object]
      Hide records attributes Show records attributes object
      • topic string
      • key string
      • value string
      • partition integer
      • offset integer
  • Topic or partition not found

    Hide response attributes Show response attributes object
    • error_code integer
    • message string
    Hide response attributes Show response attributes object
    • error_code integer
    • message string
GET /topics/{topic_name}/partitions/{partition_id}/records
curl \
 --request GET 'http://{{Host}}/topics/{topic_name}/partitions/{partition_id}/records?offset=42&timeout=42&max_bytes=42'
Response examples (200)
{
  "records": [
    {
      "topic": "string",
      "key": "string",
      "value": "string",
      "partition": 42,
      "offset": 42
    }
  ]
}
Response examples (200)
{
  "records": [
    {
      "topic": "string",
      "key": "string",
      "value": "string",
      "partition": 42,
      "offset": 42
    }
  ]
}
Response examples (404)
{
  "error_code": 42,
  "message": "string"
}
Response examples (404)
{
  "error_code": 42,
  "message": "string"
}