> ## Documentation Index > Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt > Use this file to discover all available pages before exploring further. # Get organization usage > Returns an organization's usage of one metric over time, summed across all its projects, in hourly or daily buckets. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/organizations/{id}/usage openapi: 3.1.0 info: title: Qumo Deploy REST API description: > The Qumo Deploy control plane: organizations, projects, signing keys, machine identities, access control, audit and billing. Relay credentials are not issued here: your app signs them with its own [signing keys](/guides/signing-keys). Every operation here is generated against the routes the server registers and checked in CI, so an operation in this reference exists and a route missing from it is deliberately internal (relay mesh, webhooks, probes, operator-only and browser sign-in routes). Errors are JSON objects with one `error` field. What each status code means is in [Error codes](/guides/error-codes); the token scope each permission needs is in [Scopes and permissions](/guides/scopes-permissions). version: 1.0.0 servers: - url: https://api.qumo-deploy.com description: Public API (Bearer tokens only; cookies are ignored) security: [] tags: - name: Account description: The signed-in user's own sessions, tokens, security settings and data. - name: Device flow description: OAuth 2.0 device authorization, used by `qumod login`. - name: Organizations description: Organizations, their members and usage. - name: Projects description: Projects inside an organization. - name: Signing keys description: Keys your app signs relay credentials with. - name: Relays description: Where clients of a broadcast path connect. - name: Identities description: Machine identities, their tokens and IP allowlists. - name: Access control description: Roles, IAM bindings and invitations. - name: Audit description: The audit log and its webhook. - name: Notifications description: Notification policies. - name: Billing description: Plans, usage cost, budgets, invoices and payment methods. - name: Pricing description: Public price list. paths: /v1/organizations/{id}/usage: get: tags: - Organizations summary: Get organization usage description: > Returns an organization's usage of one metric over time, summed across all its projects, in hourly or daily buckets. operationId: getOrganizationUsage parameters: - name: id in: path required: true description: The organization's id. schema: type: string format: uuid example: 3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c - name: metric in: query required: true description: | The metric to report, e.g. `gateway.egress_bytes` or `gateway.ingress_bytes`. A metric with no usage reads zero in every bucket. schema: type: string example: gateway.egress_bytes - name: granularity in: query required: false description: Bucket size. schema: type: string enum: - hour - day default: hour example: day - name: start in: query required: false description: | Start of the window, RFC 3339. Defaults to 24 hours before `end` for hourly buckets and 30 days before it for daily ones. schema: type: string format: date-time example: '2026-10-01T00:00:00Z' - name: end in: query required: false description: End of the window, RFC 3339. Defaults to now; must be after `start`. schema: type: string format: date-time example: '2026-11-01T00:00:00Z' responses: '200': description: The organization's usage. content: application/json: schema: $ref: '#/components/schemas/OrganizationUsage' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' security: - token: [] - cliSession: [] - sessionCookie: [] components: schemas: OrganizationUsage: type: object required: - organization_id - metric - granularity - periods properties: organization_id: type: string format: uuid description: The organization the usage belongs to. example: 3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c metric: type: string description: The metric queried. example: gateway.egress_bytes granularity: type: string enum: - hour - day description: Bucket size of `periods`. example: day periods: type: array description: The buckets, oldest first. items: $ref: '#/components/schemas/UsagePeriod' UsagePeriod: type: object required: - period - value properties: period: type: string format: date-time description: Start of the bucket. example: '2026-10-31T00:00:00Z' value: type: integer format: int64 description: The metric's total within the bucket. example: 5368709120 Error: type: object required: - error properties: error: type: string description: A human-readable message. example: organization_id is required responses: BadRequest: description: >- Malformed request or failed validation. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing or invalid credentials. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- Authenticated but not allowed (permission, token scope, IP allowlist or CSRF). See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: token: type: http scheme: bearer bearerFormat: qumo_pat_ description: > A personal access token (`POST /v1/auth/tokens`) or a machine identity token (`POST /v1/projects/{project_id}/identities/{identity_id}/tokens`), both prefixed `qumo_pat_`. A token's scopes cap what it can do; see [Scopes and permissions](/guides/scopes-permissions). A personal token names no organization: on a route whose path names no project or organization, pass `?organization_id=`. cliSession: type: http scheme: bearer description: | The session token `qumod login` obtains through the device flow (`POST /v1/auth/device/token`). It acts as the signed-in user, like a console session, and needs no CSRF token. sessionCookie: type: apiKey in: cookie name: __Host-qumo_session description: | The console's browser session. Accepted only on the console origin (`https://console.qumo-deploy.com`), never on `api.qumo-deploy.com`. A request that changes state must also send `X-CSRF-Token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.