Get Organization Usage

Time	Status	User Agent
Retrieving recent requests…

Use this endpoint to retrieve month-to-date API usage statistics for your organization.

When to use this endpoint

Use GET /rest/v1/orgs/usage when you need to:

Monitor month-to-date API usage for your organization.
Retrieve usage data for alerting, reporting, or internal dashboards.
Include aggregate usage, child organization usage, or accessed master tariff IDs.
Filter usage data by year and month.

Usage values are updated daily at midnight UTC. To build daily usage history, call this endpoint daily and store the returned values.

Parameter	Type	Description
`populateAggregateUsage`	boolean	Includes aggregate usage data in the response.
`populateChildOrgs`	boolean	Includes usage data for child organizations.
`populateMasterTariffIds`	boolean	Includes master tariff IDs accessed during the usage period.
`startYearMonth`	dateTime	Starts the usage date range. Only the year and month are applied.
`endYearMonth`	dateTime	Ends the usage date range. Only the year and month are applied.

Learn how organization usage responses and usage fields are modeled.

Authenticate with the appId and appKey for the organization whose usage you want to retrieve.

Review pagination, searching, sorting, and request formatting.