Get Kafka Topic Stats

This endpoint gets detailed stats of a Kafka cluster.

URL Parameters

id

required

The ID of the Kafka topic

Response Parameters

throughput

Object

Show Properties

x

string

Timestamp indicating when the measurement was taken.

y

int

Number of monthly messages in Kafka topic

produce_throughput

Object

Show Properties

x

string

Timestamp indicating when the measurement was taken.

y

int

Number of monthly messages produced in Kafka topic

consume_throughput

Object

Show Properties

x

string

Timestamp indicating when the measurement was taken.

y

int

Number of monthly messages consumed in Kafka topic

diskusage

Object

Show Properties

x

string

Timestamp indicating when the measurement was taken.

y

int

Total disk usage of the Kafka topic

total_monthly_storage

int

Average storage size of the Kafka topic in the current month

total_monthly_produce

int

Total number of monthly produced messages to the Kafka topic

total_monthly_consume

int

Total number of monthly consumed messages from the Kafka topic

curl

curl -X GET \
  https://api.upstash.com/v2/kafka/stats/topic/:id \
  -u 'EMAIL:API_KEY'

200 OK

{
  "throughput": [
    {
      "x": "2022-02-07 12:05:11",
      "y": 0
    }
    ...
  ],
  "produce_throughput": [
    {
      "x": "2022-02-07 12:05:11",
      "y": 0
    }
    ...
  ],
  "consume_throughput": [
    {
      "x": "2022-02-07 12:05:11",
      "y": 0
    }
    ...
  ],
  "diskusage": [
    {
      "x": "2022-02-07 12:20:11",
      "y": 0
    }
    ...
  ],
  "total_monthly_storage": 0,
  "total_monthly_produce": 0,
  "total_monthly_consume": 0
}