Skip to main content
GET
Usage

Authorizations

Authorization
string
header
required

A workspace API key.

Query Parameters

from
string<date>

First day of the window, inclusive. YYYY-MM-DD. Defaults to 30 days ago.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-01"

to
string<date>

Last day of the window, inclusive and counted whole. YYYY-MM-DD. Defaults to today.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-31"

Response

Success.

success
boolean
required
from
string<date>
required

Start of the window, inclusive.

Example:

"2026-07-01"

to
string<date>
required

End of the window, inclusive.

Example:

"2026-07-31"

totals
object
required

The window in one row.

byCapability
object[]
required

Heaviest spend first.

byKey
object[]
required

Which key spent it.

byDate
object[]
required

Oldest day first.

creditBalance
number | null

Balance now, not at to.

{key}
any