APapinizer
UsageReport

Budget board of an application's API clients

Changed on

One row per API client of the application, carrying the live quota window closest to its limit. A client migrated from a legacy credential is still matched through that credential's counters, so its board row does not go blank on the day of the migration.

get/apiops/projects/{projectName}/applications/{applicationKey}/usage/budget-board

Request

Path parameters

projectNamestring required

Project name

applicationKeystring required

Application key

Query parameters

pageinteger

Zero-based page index.

sizeinteger

Page size. Defaults to 20, capped at 200.

sortstring

percent[,asc|desc]; defaults to percent,desc. name is always accepted as the tie-breaker.

Response

successful operation!

childType'ORGANIZATION' | 'CONSUMER' | 'APPLICATION' | 'API_CLIENT' | 'API_PROXY'

What kind of child each row is: CONSUMER under an organization, API_CLIENT under an application.

totalElementsinteger

Children in the whole list, not only on this page.

pageinteger

Zero-based page index.

sizeinteger

Page size actually used.

asOfstring

How fresh the rows are (the quota snapshot's last sync).

notesstring[]

Machine-readable notes.

Example response

{
  "items": [
    {
      "window": "ONE_MONTH"
    }
  ],
  "asOf": "2026-09-11T08:31:02Z"
}

Changes

  • d1a546deccf0Revision changes
    • breaking

      for the query request parameter page, the format changed from no format to int32

    • breaking

      for the query request parameter size, the format changed from no format to int32

    This list may be incomplete.

  • 90cf59a80235Revision changes
    • info

      endpoint added