Skip to main content
GET
cURL

Authorizations

Authorization
string
header
default:dav_ak_live_your_token
required

Personal access token. The scopes granted at issuance determine both which operations the key may call and the ceiling on the resource permissions it can exercise. Each scope family is a ladder: projects:manage implies projects:write and projects:read; cards:manage implies cards:write and cards:read; and teams:manage implies teams:write and teams:read. These are named API capability bundles, not blanket domain roles: manage exposes only the permissions enumerated for that scope and never bypasses the acting user's current role-based access.

Path Parameters

projectId
string
required

Project id. May be compound in the form {projectId}--{branchName}.

Minimum string length: 1
sessionId
string<uuid>
required

Session id from createSession.

Query Parameters

from
string<date-time>

Only count events at or after this time. Omit for all of recorded history.

to
string<date-time>

Only count events at or before this time.

groupBy
enum<string>

Break the totals down. Omit to receive totals only — totals is always present and always covers the whole scope, whether or not you group.

Available options:
model,
project,
session,
day

Response

Usage totals for the session.

scope
enum<string>
required

What the numbers cover, determined by the path you called.

Available options:
account,
project,
session
asOf
string<date-time> | null
required

When the newest counted event was recorded, or null when the scope holds none. This is the honest bound on freshness: the engine reports usage on an interval, so a run's last few seconds may not be included. Null means "nothing here", not "nothing yet" — a scope with no usage looks the same either way, and inventing a timestamp would hide that.

totals
object
required
projectId
string

Present on the project and session reads. Always the bare id.

sessionId
string<uuid>

Present on the session read.

groupBy
enum<string>

Echoed back when you asked for a breakdown.

Available options:
model,
project,
session,
day
groups
object[]

One entry per group, largest spend first — except day, which is chronological. Absent unless you passed groupBy.