Skip to content

API Endpoints

Qichao Chu edited this page Apr 9, 2026 · 1 revision

API Endpoints

Get lag for a specific consumer group and topic

GET /api/v1/lag/{group}/{topic}

Response:

{
  "group": "my-consumer",
  "topic": "my-topic",
  "cluster": "default",
  "totalLag": 1234,
  "partitions": {
    "0": {"partition": 0, "beginningOffset": 0, "committedOffset": 100, "endOffset": 150, "lag": 50},
    "1": {"partition": 1, "beginningOffset": 0, "committedOffset": 200, "endOffset": 300, "lag": 100}
  }
}

Get lag summary for a consumer group

GET /api/v1/lag/{group}

Health check

GET /actuator/health

Prometheus metrics

GET /actuator/prometheus

Clone this wiki locally