Skip to main content
GET
/
usage
/
v1

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Query Parameters

periodStart
string<date-time>

Period start date. Defaults to the start of the current calendar month.

periodEnd
string<date-time>

Period end date. Defaults to now.

granularity
enum<string>
default:summary

Whether to return period totals only or include daily buckets.

Available options:
summary,
daily
lincSessionId
string

Restrict usage to a native Linc session. The session must belong to the authenticated organization.

groupBy
enum<string>

Optionally include usage groups keyed by native Linc session id. Only Linc-session-attributable usage is grouped.

Available options:
lincSessionId

Response

Usage snapshot retrieved successfully