Skip to main content
GET
Get Usage Summary
Credits: 0.
Beta. The usage summary schema is new and may evolve. Field names should be stable, but we reserve the right to add fields or adjust response shape before general availability.

Overview

Returns a daily usage breakdown for the authenticated organization over a date range, then attaches the current plan pool’s credit status. It is real time: days the hourly rollup has finalized come from pre-aggregated daily rollups, and days it has not finalized are read live, so a request counts as soon as it completes. Group the results by day, endpoint_type, or api_key, and optionally filter to a single endpoint type. Requires the billing:read scope. Querying the summary does not consume metered usage.

Query Parameters

string
required
Start of date range (YYYY-MM-DD).
string
required
End of date range (YYYY-MM-DD), inclusive.
string
default:"day"
Grouping dimension. One of day, endpoint_type, or api_key.
string
Restrict the data rows to one endpoint type (e.g. search, read). The billing_period block is plan-wide and does not change with this filter.

Response

string
Always "list".
object[]
boolean
Always false — the summary is fully returned in one response.
object
string
Request ID for debugging.

Code Examples