Skip to main content
GET
Get project model usage

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

Query Parameters

preset
enum<string>
default:30d

Whole local days, defaulting to 30d. Explicit from/to bounds take precedence over preset, including SDK-supplied defaults.

Available options:
7d,
30d,
90d
from
string<date-time>

Inclusive start. Supply both from and to; these bounds take precedence over preset.

to
string<date-time>

Exclusive end, no later than the end of today in timezone.

timezone
string
default:UTC
granularity
enum<string>
default:day

UTC hours, or local calendar days, Monday-based weeks and months.

Available options:
hour,
day,
week,
month
group_by
enum<string>[]

Grouping dimensions supported by this operation. Repeat the parameter or use a comma-separated list.

Maximum array length: 4
Available options:
project,
model,
api_key,
member
compare
enum<string>

Compare preceding calendar months for whole-month custom ranges, local days for whole-day ranges and presets, or equal elapsed duration otherwise.

Available options:
previous_period
member_id
string<uuid>

Filter to calls with this recorded actor user ID.

Response

Recorded project model usage.

scope
object
required
timeframe
object
required
summary
object
required
models
object[]
required

One row per model/vendor/inference-provider identity, ranked by calls.

projects
object[]
required

Account usage by project and model; null project ID is unscoped usage. Empty for project reports.

series
object[]
required

Bucket totals and model breakdowns. Quiet buckets have zero totals and no model or grouping rows.

attribution
object
required
group_by
enum<string>[]

Requested series grouping dimensions; omitted for the default report.

Available options:
project,
model,
api_key,
member