Skip to main content
GET
Get overall usage summary

Authorizations

Authorization
string
header
required

JWT authentication token

Query Parameters

from
string<date-time>

Filter from datetime (ISO 8601)

to
string<date-time>

Filter to datetime (ISO 8601)

group_by
enum<string>

Group by time period

Available options:
day,
week,
month

Response

Usage summary

by_model
object
required

Usage statistics by model

by_status
object
required

Task counts by status

total_neo_credits
number<float>
required

Total Neo credits used

total_tasks
integer
required

Total number of tasks

by_email
object[]

Usage statistics by team member email, sorted by neo_credits descending (only for team admins)

by_period
object[]

Usage statistics by time period (only if group_by is specified)

by_project
object[]

Usage statistics by project, sorted by neo_credits descending. Pure usage analytics (no spending caps).

byok
object

BYOK (Bring Your Own Key) usage breakdown

grand_total_issued_credits
number<float>

Grand total credits ever issued. For subscription customers, the sum of every monthly subscription grant (subscription_grant/renew/proration) plus all top-up purchases and positive admin amount grants. For non-subscription customers, top-up purchases and admin amount grants only. Not reduced by usage, expiry, or cancellation.

grand_total_used_credits
number<float>

Total task spend counted from the most recent admin usage reset (reset_usage event); all-time when no admin reset exists. Independent of subscription renewal/settlement window moves.

last_credit_reset
string<date-time> | null

When set, the datetime from which credit usage is counted. Usage before this date is excluded from used/available credit calculations.

neo_credits_expires_at
string<date-time> | null

When set, credits will be frozen (available=0) after this date. NULL means never expires.

neo_credits_is_expired
boolean

Whether the Neo credits have expired (expires_at is in the past)

total_agent_triggers
integer

Total agent triggers

total_available_neo_credits
number<float>

Available Neo credits since last reset (issued - used since reset). Not affected by date filters. Returns 0 if credits are expired.

total_execution_ms
integer

Total execution time in milliseconds

total_issued_neo_credits
number<float>

Total Neo credits issued/allocated to the user

total_neo_credits_post_reset
number<float>

Neo credits used since the last reset (issued - available). Not affected by date filters.

total_steps
integer

Total steps executed

total_tool_calls
integer

Total tool calls