STstreamkap
Usage

Top topics by data volume

Changed on

Rank your Kafka topics by the data volume they moved over a date range, largest first, with everything past the requested limit folded into an others rollup so the parts add up to the total. Volumes are returned in both bytes and decimal GB.

Unlike the other usage endpoints, which report six fixed rolling windows, this one takes an explicit range — so it is the one that can answer which topics drove a given month's bill. end_date is exclusive.

direction=in ranks by what your sources ingested; direction=out by what your destinations delivered. Out-direction figures are per topic consumed, so a topic read by several destinations appears once with their combined volume.

get/billing/usage/top-topics

Request

Query parameters

start_datestring date required

First day to count, inclusive (YYYY-MM-DD).

end_datestring date required

Day to stop at, EXCLUSIVE (YYYY-MM-DD) — pass the day after the last day you want counted. For all of June 2026: start_date=2026-06-01, end_date=2026-07-01.

direction'in' | 'out'

Which side of the pipeline a volume figure describes.

Which direction to rank topics by: 'in' for bytes ingested by your sources, 'out' for bytes delivered to your destinations.

limitinteger

How many topics to list individually (1-50). Everything below that is folded into others.

tenant_idsstring nullable

Comma-separated sub-account tenant IDs to include alongside your own, for a parent account. Each is verified against your tenant tree. Omit to report only your own tenant.

Request body

Response

Successful Response

direction'in' | 'out' required

Which side of the pipeline a volume figure describes.

start_datestring date required

First day counted, inclusive, echoing the request.

end_datestring date required

Day counting stopped at, exclusive, echoing the request.

total_volume_bytesnumber

Total across all topics in the window, in bytes.

total_volume_gbnumber

The same total in decimal GB, rounded to 4dp.

Changes