Skip to main content
GET
Get Interview Usage

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Query Parameters

start_date
string<date> | null

Inclusive UTC start date

end_date
string<date> | null

Inclusive UTC end date

cadence
enum<string> | null
Available options:
daily,
weekly,
monthly
app_id
string | null

Response

Successful Response

total_interviews
integer
required
total_units
number
required
usage_stats
PublicUsageBucket · object[]
required
scope
UsageStatsScope · object
required