Export usage events as CSV
const url = 'http://localhost:8080/v1/exports/usage-events.csv?from=example&to=example';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/exports/usage-events.csv?from=example&to=example' \ --header 'Authorization: Bearer <token>'Streams usage events whose timestamp falls in the window,
newest first, from one consistent snapshot. from and to are
both required and may span at most 366 days. customer_id,
meter_id and dimensions narrow it like the event list. Columns: id,
customer_id, meter_id, quantity, timestamp, idempotency_key,
origin, dimensions_json, provider_cost_cents (US cents, a decimal),
provider_cost_source.
Audit row, EXPORT_INCOMPLETE marker and formula escaping work
as in the customers export.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Lower bound on the event timestamp, inclusive. RFC 3339 or YYYY-MM-DD.
Upper bound on the event timestamp, inclusive. RFC 3339 or YYYY-MM-DD (end of that day, UTC).
Only this customer’s events.
Only this meter’s events.
Comma-separated key=value pairs, same syntax as GET /v1/usage-events.
Responses
Section titled “Responses”CSV file (sent as an attachment).
from or to is missing, or the window is longer than 366 days.
object
object
One of invalid_request_error, authentication_error,
rate_limit_error or api_error. Every error the API
answers has this shape, including an unknown path (404,
code route_not_found) and a method the path does not take
(405, code method_not_allowed, with an Allow header).
The few exceptions are listed in docs/api-surface.md.
The request field the error is about. Sent only when the error
names one. A request body may hold only the fields its
operation lists, spelled and cased as listed: any other
field, or one the server sets (such as id), is refused
with 422 and param naming it. An operation with no request body lists no fields: send
no body, {} or null. The Stripe and Postmark webhooks and
the LiteLLM callback take their sender’s body as it comes.
Example
{ "error": { "type": "invalid_request_error" }}from or to is malformed, to is before from, or a dimensions pair is malformed.
object
object
One of invalid_request_error, authentication_error,
rate_limit_error or api_error. Every error the API
answers has this shape, including an unknown path (404,
code route_not_found) and a method the path does not take
(405, code method_not_allowed, with an Allow header).
The few exceptions are listed in docs/api-surface.md.
The request field the error is about. Sent only when the error
names one. A request body may hold only the fields its
operation lists, spelled and cased as listed: any other
field, or one the server sets (such as id), is refused
with 422 and param naming it. An operation with no request body lists no fields: send
no body, {} or null. The Stripe and Postmark webhooks and
the LiteLLM callback take their sender’s body as it comes.
Example
{ "error": { "type": "invalid_request_error" }}The export’s audit row could not be written; nothing was sent.
object
object
One of invalid_request_error, authentication_error,
rate_limit_error or api_error. Every error the API
answers has this shape, including an unknown path (404,
code route_not_found) and a method the path does not take
(405, code method_not_allowed, with an Allow header).
The few exceptions are listed in docs/api-surface.md.
The request field the error is about. Sent only when the error
names one. A request body may hold only the fields its
operation lists, spelled and cased as listed: any other
field, or one the server sets (such as id), is refused
with 422 and param naming it. An operation with no request body lists no fields: send
no body, {} or null. The Stripe and Postmark webhooks and
the LiteLLM callback take their sender’s body as it comes.
Example
{ "error": { "type": "invalid_request_error" }}