Home

/kafka/{cluster_name}/kpi_topics?start_time={timestamp}&end_time={timestamp}&interval={minutes}&prefix={metrics}

Gets KPIs for the Kafka topics within a given timespan.

Request
GET http://unravel-host:3000/api/v1/kafka/{cluster_name}/kpi_topics?start_time={timestamp}&end_time={timestamp}&interval={minutes}&prefix={metrics+topic_OneMinuteRate}
Path parameters

Name

Description

cluster_name

Cluster name.

Query parameters

Required parameters are highlighted.

Name

Type

Description

start_time

string

Start time. Format: YYYY-MM-DDTHH:MM:SS.NNNZ or Unix epoch time.

end_time

string

End time. Format: YYYY-MM-DDTHH:MM:SS.NNNZ or Unix epoch time.

interval

string

Size of interval in minutes .

prefix

string

List of topics names to graph. Separate each metric with +.

Response body

The response body contains one array per topic, with the following fields.

Name

Type

Description

ts

string

Timestamp.

avg_vd

string

Examples

Request:

curl -X GET "http://myserver.com:3000/api/v1/kafka/QAHDP26B/kpi_topics?end_time=2019-06-04T10:21:55%2B05:30&interval=1m&prefix=BytesInPerSec___consumer_offsets-OneMinuteRate&start_time=2019-06-04T09:21:55%2B05:30" -H  "accept: application/json" -H  "Authorization: JWT token"

Response:

{"__consumer_offsets":[{"ts":1559620320000,"avg_vd":"4310.999986671694"}]}