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}/lagsimport requests
url = "https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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>"
}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}/lagsimport requests
url = "https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/v1/consumer-groups/{consumer_group_id}/lags")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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>"
}