Cloud API
Pulsar REST Messaging API
Kafka REST API
Consumer Groups
Return a list of consumer lags of the consumers belonging to the specified consumer group.
Retrieves consumer lag information for all topic partitions consumed by the specified consumer group. Lag represents the difference between the latest offset and the consumer’s current position.
GET
/
admin
/
v1
/
consumer-groups
/
{consumer_group_id}
/
lags
Return a list of consumer lags of the consumers belonging to the specified consumer group.
curl --request GET \
--url https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags{
"data": [
{
"consumer_group_id": "<string>",
"topic_name": "<string>",
"partition_id": 123,
"consumer_id": "<string>",
"host": "<string>",
"client_id": "<string>",
"current_offset": 123,
"log_end_offset": 123,
"lag": 123,
"metadata": {},
"kind": "<string>"
}
],
"metadata": {},
"kind": "<string>"
}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.
Was this page helpful?
Return the consumer group specified by the consumer_group_id.
Previous
Produce records to the given topic, returning delivery reports for each record produced.
Next
⌘I
Return a list of consumer lags of the consumers belonging to the specified consumer group.
curl --request GET \
--url https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags{
"data": [
{
"consumer_group_id": "<string>",
"topic_name": "<string>",
"partition_id": 123,
"consumer_id": "<string>",
"host": "<string>",
"client_id": "<string>",
"current_offset": 123,
"log_end_offset": 123,
"lag": 123,
"metadata": {},
"kind": "<string>"
}
],
"metadata": {},
"kind": "<string>"
}