http request get consumer detail

Name

Get Consumer Detail

Usage

This endpoint returns all stored information for a single consumer group

URL path

GET /v3/kafka/(cluster)/consumer/(group)

Parameters

Name	Format	Description
cluster	string	The name of a Kafka cluster, as returned by the [[List Clusters
group	string	The name of a Kafka consumer group, as returned by the [[List Consumers

Response

The response contains an topics key, which is a map of topic names to details:

{
    "error": false,
    "message": "consumer detail returned",
    "request": {
        "host": "responding.host.example.com",
        "url": "/v3/kafka/tracking/consumer/megaphone-bps"
    },
    "topics": {
        "ConsumedTopicName": [
            {
                "current-lag": 0,
                "offsets": [
                    {
                        "lag": 0,
                        "offset": 2526,
                        "timestamp": 1511200836090
                    },
                    {
                        "lag": 0,
                        "offset": 2527,
                        "timestamp": 1511321306786
                    }
                ],
                "owner": ""
            }
        ]
    }
}

Possible errors

• Cluster Not Found If an unknown cluster name is provided, a 404 error will be returned with a JSON response body.
• Group Not Found If an unknown consumer group name is provided, a 404 error will be returned with a JSON response body.
• JSON Encoding Error If there is a failure encoding the JSON response, a 500 error will be returned with a JSON response body.