Hanzo
Sign InGet API Key
OpenapiLink

Shows one provider account's own usage dashboard.

Shows one provider account's own usage dashboard.

GET /v1/link/usage

Link → · All API references → · Six flows, four surfaces →

Addresshttps://api.hanzo.ai/v1/link/usage
MethodGET
Operationget_link_usage
AuthAuthorization: Bearer $HANZO_API_KEY

Shows one provider account's own usage dashboard.

It answers the time series for a SINGLE provider account — the windows in range plus the currently-open ones — as that provider's own meter reported it: "my plan is 47% through its 6h window, resets at 14:20". current is the newest instance of each lane (the headline); windows is the history behind it, both computed from ONE deduped read. provider is required; an unknown window class or range is 400, never a quiet fallback to a different one. When no series is available the response is a 200 with available:false and empty lists — an honest "we have no data", which is a different claim from zero usage.

Request

4 fields.

FieldInTypeRequiredDescription
providerquerystring—Provider is the provider whose meter to read.
accountquerystring—Account narrows to one account when a user has several with the provider.
windowquerystring—Window selects a window class: 6h, day, week or month.
rangequerystring—Range is the period, one of 1h, 24h, 7d or 30d; empty means 24h, and an unknown label is 400, never a quiet fallback.

Response

StatusBodyMeaning
200boardRespok

200 body — 48 fields.

FieldInTypeAlwaysDescription
accountbodystring—Account is the account the series narrows to, when one was named.
availablebodyboolean—Available reports whether the warehouse answered; false is an honest "we have no data", NOT zero usage.
currentbodyreadingView[]—Current is the live state of each lane — the dash headline.
current[].accountbodystring—Account is the provider-side account the sample belongs to.
current[].cachedInputTokensbodyinteger—CachedInputTokens is the window's cached-prompt-token count.
current[].confidencebodystring—Confidence says whether the counters that remain mean anything, as the meter graded itself.
current[].costCentsbodyinteger—CostCents is the window's spend in cents, as the provider's meter states it.
current[].costLimitCentsbodyinteger—CostLimitCents is the window's spend cap in cents, when the meter knows one.
current[].currencybodystring—Currency is the ISO currency the cost fields are stated in.
current[].inputTokensbodyinteger—InputTokens is the window's prompt-token count.
current[].lanebodystring—Lane names the meter's own lane label for this measurement.
current[].machinebodystring—Machine is the machine the collector observed the account on.
current[].outputTokensbodyinteger—OutputTokens is the window's completion-token count.
current[].planbodystring—Plan is the provider plan label the account is on.
current[].requestsbodyinteger—Requests is the window's request count.
current[].resetsAtbodystring—ResetsAt is when the window resets, RFC 3339 UTC.
current[].syntheticbodyboolean—Synthetic marks a sample the collector derived rather than observed.
current[].totalTokensbodyinteger—TotalTokens is the window's total token count.
current[].usedPctbodynumber—UsedPct is how much of the window's allowance is consumed, 0..100.
current[].windowbodystring—Window is the window class: 6h, day, week or month.
current[].windowMinutesbodyinteger—WindowMinutes is the window's length as the meter reported it.
current[].windowStartbodystring—WindowStart is when the measured window opened, RFC 3339 UTC.
frombodystring—From is when the resolved window opens, RFC 3339 UTC.
providerbodystring—Provider is the provider whose meter answered.
rangebodystring—Range is the resolved period label.
scopebodystring—Scope is always "user": the caller's own linked accounts.
sourcebodystring—Source is always "account": the provider's own meter, not a Hanzo charge.
tobodystring—To is where it closes, EXCLUSIVE, RFC 3339 UTC — the instant the read was served, so the window walks forward with the clock and two reads a minute apart do…
windowsbodyreadingView[]—Windows is every window instance in range, newest first.
windows[].accountbodystring—Account is the provider-side account the sample belongs to.
windows[].cachedInputTokensbodyinteger—CachedInputTokens is the window's cached-prompt-token count.
windows[].confidencebodystring—Confidence says whether the counters that remain mean anything, as the meter graded itself.
windows[].costCentsbodyinteger—CostCents is the window's spend in cents, as the provider's meter states it.
windows[].costLimitCentsbodyinteger—CostLimitCents is the window's spend cap in cents, when the meter knows one.
windows[].currencybodystring—Currency is the ISO currency the cost fields are stated in.
windows[].inputTokensbodyinteger—InputTokens is the window's prompt-token count.
windows[].lanebodystring—Lane names the meter's own lane label for this measurement.
windows[].machinebodystring—Machine is the machine the collector observed the account on.
windows[].outputTokensbodyinteger—OutputTokens is the window's completion-token count.
windows[].planbodystring—Plan is the provider plan label the account is on.
windows[].requestsbodyinteger—Requests is the window's request count.
windows[].resetsAtbodystring—ResetsAt is when the window resets, RFC 3339 UTC.
windows[].syntheticbodyboolean—Synthetic marks a sample the collector derived rather than observed.
windows[].totalTokensbodyinteger—TotalTokens is the window's total token count.
windows[].usedPctbodynumber—UsedPct is how much of the window's allowance is consumed, 0..100.
windows[].windowbodystring—Window is the window class: 6h, day, week or month.
windows[].windowMinutesbodyinteger—WindowMinutes is the window's length as the meter reported it.
windows[].windowStartbodystring—WindowStart is when the measured window opened, RFC 3339 UTC.

Failure carries the platform error shape — see Errors.

Examples

hanzo links usage get

Link API · All Hanzo APIs · Interactive reference

How is this guide?

On this page

RequestResponseExamples