Sign in

v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB
Usage

Get usage summary

Retrieve aggregated usage data across all customers for the tenant.

get/api/v1/usage/summary

Query parameters

start_datestring date required
end_datestring date required
metric_idstring MeteroidId
Example:bm_7n42DGM5Tflk9n8mt7Fhc7

Response

Usage summary

period_endstring date required
period_startstring date required

Example response

{
  "usage": [
    {
      "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}