Skip to main content
GET
List charges or runs

Authorizations

Authorization
string
header
required

varg API key (varg_...). Get one at app.varg.ai or run bunx vargai login. App sessions may alternatively send a Supabase JWT.

Query Parameters

from
string

Range start, inclusive. YYYY-MM-DD (local midnight in timezone), a local date-time (2026-09-01T09:30), or an ISO 8601 instant with offset. Default: to minus 30 days. Ranges are limited to 366 days.

Maximum string length: 40
to
string

Range end, exclusive. Same formats as from. Default is now.

Maximum string length: 40
timezone
string

IANA timezone used for date-only bounds and calendar buckets. Default UTC.

Maximum string length: 64
compare
enum<string>

previous_period compares against the equal-length period right before from; none disables comparison. Default is previous_period on /analytics/summary and none elsewhere. Ignored when compare_from/compare_to are given.

Available options:
previous_period,
none
compare_from
string

Explicit comparison start. Must be sent together with compare_to.

Maximum string length: 40
compare_to
string

Explicit comparison end, exclusive. Must be sent together with compare_from.

Maximum string length: 40
tool
string

Filter by capability. Comma-separated tool keys (video, image, speech, music, render, pipeline, ...) or none. Up to 50 values.

Maximum string length: 4000
model
string

Filter by model. Comma-separated model ids or none. Up to 50 values.

Maximum string length: 4000
workspace_id
string

Filter by folder. Comma-separated folder ids or none (no folder). Up to 50 values.

Maximum string length: 4000
api_key_id
string

Filter by the API key that started the run. Comma-separated key ids or none. Up to 50 values.

Maximum string length: 4000
member_id
string

Filter by the person who started the run. Comma-separated user ids or none. Up to 50 values.

Maximum string length: 4000
creator
string

Filter by creator: api_key:<id> (a personal API key) or member:<id> (a person), comma-separated, or none. Up to 50 values.

Maximum string length: 4000
source
string

Filter by how the run was started. Comma-separated values of app (a person in the web app), api (API key, SDK, CLI), mcp (an agent via MCP), internal (varg system keys), unknown.

Maximum string length: 4000
status
string

Filter by the charged job's status. Comma-separated values of completed, failed, cancelled, awaiting_confirmation, running, submitting, queued, unknown.

Maximum string length: 4000
group
enum<string>
default:charge

charge (default) lists individual ledger charges; run groups them by run.

Available options:
charge,
run
sort
enum<string>
default:recent

recent (default) newest first; amount largest first.

Available options:
recent,
amount
limit
integer
default:50

Page size. 1-200, default 50. Out-of-range values are clamped. Ignored for CSV.

Required range: 1 <= x <= 200
cursor
string

The next_cursor of the previous page. Opaque; only valid with the same group and sort.

Maximum string length: 400
format
enum<string>

json (default) returns the { data, meta } envelope. csv returns the same rows as text/csv with a Content-Disposition attachment filename. Amounts are in credits.

Available options:
json,
csv

Response

Result envelope (JSON) or CSV export

data
object
required
meta
object
required

Metadata describing how the numbers were computed.