Retrieve brick usage time series
Returns usage submitted against a brick, aggregated into fixed-size buckets (hour, day, week, or month). Decoupled from billing periods: the response contains only the raw sum of units per bucket and does NOT include pre-commitment, remaining, overages, or overage rate. For commitment-scoped fields, use the /usage endpoint instead.
Buckets are aligned to the subscription’s time zone. Missing buckets (no events submitted) are returned with count=0 so the series is contiguous.
Pool bricks: when the brick is a usage pool, counts are summed in the pool’s own unit space (pool_count, after each contributing brick’s pool_unit_rate conversion). For raw event counts against an individual pooled brick, query that brick directly.
Documentation Index
Fetch the complete documentation index at: https://docs.salesbricks.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key for authentication
Path Parameters
^([a-zA-Z\d\-]+)$^([a-zA-Z\d\-]+)$Query Parameters
Start of the range (inclusive). ISO 8601 (YYYY-MM-DD or full datetime). Date-only values are interpreted in the subscription's time zone. Defaults to the subscription's current order start date.
End of the range (exclusive). ISO 8601. Defaults to the current time. Must be after from.
Bucket size. Defaults to 'day'.
day, hour, month, week Response
Windowed usage time series for a brick. Decoupled from billing periods and commitment-period concepts (pre-commitment, remaining, overages).
The unit of measurement for this brick (e.g., 'API calls'). Defaults to 'Unit'.
The bucket size: hour, day, week, or month.
hour- hourday- dayweek- weekmonth- month
hour, day, week, month