STstreamkap
Usage

Top topics by data volume (POST)

Changed on

Identical filters and response to GET /billing/usage/top-topics, which is the one to prefer. Use this when the query string would be too long for a URL — typically a parent account naming a hundred sub-accounts. Body values take precedence over query parameters.

post/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