COconfluentinc
Consumer Group (v3)

Get Consumer Group Lag Summary

Changed on

Generally Available Available in dedicated clusters only

Return the maximum and total lag of the consumers belonging to the specified consumer group.

get/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary

Request

  • Base URL
    http://localhost:8082/v3
  • URL
    http://localhost:8082/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary
  • Auth
    none declared

Response

The max and total consumer lag in a consumer group.

kindstring required
cluster_idstring required
consumer_group_idstring required
max_lag_consumer_idstring required
max_lag_instance_idstring nullable
max_lag_client_idstring required
max_lag_topic_namestring required
max_lag_partition_idinteger required
max_laginteger required
total_laginteger required

Changes

  • v325e5259d1722Revision changes
    • breaking

      removed the media type text/plain for the response with the status

    • info

      api operation id getKafkaV3ConsumerGroupLagSummary removed and replaced with getKafkaConsumerGroupLagSummary

    • info

      added the non-success response with the status

  • v31be42847ed21Revision changes
    • info

      api operation id getKafkaConsumerGroupLagSummary removed and replaced with getKafkaV3ConsumerGroupLagSummary

    • info

      added the media type text/plain for the response with the status

    • info

      removed the non-success response with the status