Skip to main content
GET
Get organization metrics (Admin only)

Authorizations

Authorization
string
header
required

JWT access token for user authentication (Authorization: Bearer <jwt_token>). Create via POST /users/me/access_tokens.

Path Parameters

org_id
string
required

Organization ID to get metrics for

Query Parameters

start
string

Start of time range (ISO 8601). Defaults to 30 days ago. Window may not exceed 366 days.

end
string

End of time range (ISO 8601). Defaults to now. Window may not exceed 366 days.

credit_type
enum<string>

Filter consumed inference usage by grant, staking_farm, transfer, payment, or postpay. Costs include only saved matching allocations, including settlements. Each matching request and its full tokens count once; counts are not additive across credit types. Unattributed historical usage is excluded. Period totals may increase until outstanding unfunded usage is settled. Omit for all usage. Credit type for organization limits

  • grant: Free credits provided by the platform
  • payment: Credits purchased by the organization
  • staking_farm: House of Stake farm reward units converted into credits
  • postpay: Contract billing safety ceiling; usage is invoiced separately
Available options:
grant,
payment,
staking_farm,
transfer,
postpay

Response

Organization metrics retrieved successfully

Complete organization metrics response

by_api_key
object[]
required
by_model
object[]
required
by_workspace
object[]
required
organization_id
string<uuid>
required
organization_name
string
required
period_end
string<date-time>
required
period_start
string<date-time>
required
summary
object
required

Summary metrics for an organization over a time period