Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →
Get usage over time
GET
/v1/analytics/usage
const url = 'http://localhost:8080/v1/analytics/usage?period=7d';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'http://localhost:8080/v1/analytics/usage?period=7d' \ --header 'Authorization: Bearer <token>'Returns usage-event counts and summed quantities per day, or per
month for 12m, the 10 meters with the most events, and totals.
Buckets and meters with no events are left out. Data from
customers on test clocks is left out.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”period
string
The window. Any other value is treated as 30d. 12m is 365 days.
Responses
Section titled “Responses”Usage series, top meters and totals.
Media typeapplication/json
object
period
required
string
data
required
Array<object>
object
date
required
Bucket start, YYYY-MM-DD (or YYYY-MM for 12m), in UTC.
string
events
required
integer format: int64
quantity
required
Summed quantity, as a decimal string.
string
top_meters
required
Array<object>
object
meter_id
required
string
meter_name
required
string
event_name
required
string
events
required
integer format: int64
quantity
required
Summed quantity, as a decimal string.
string
totals
required
object
events
required
integer format: int64
quantity
required
Summed quantity, as a decimal string.
string
Example
{ "period": "7d"}