Skip to main content
GET
Get Usage Report

Authorizations

Authorization
string
header
required

A control-plane management key using the sk-cp- prefix. Inference keys are not accepted by control-plane endpoints.

Path Parameters

org_id
string
required

Organization ID or slug

Query Parameters

workspace_id
string<uuid> | null

Workspace id

period
enum<string>
default:30d

Period

Available options:
today,
7d,
30d,
month_to_date,
custom
timezone
string
default:UTC

Timezone

start_date
string<date> | null

Start date

end_date
string<date> | null

End date

start_at
string<date-time> | null

Start at

end_at
string<date-time> | null

End at

owner_id
string<uuid> | null

Owner id

key_id
string | null

Management key ID

model_id
string | null

Model id

provider_id
string | null

Provider id

credential_id
string<uuid> | null

Provider credential ID

Response

Successful Response

data
UsageReportOut · object
required