> ## Documentation Index
> Fetch the complete documentation index at: https://docs.validationcloud.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Team-wide compute-unit usage

> Aggregated compute-unit usage for the team the admin key is bound to. Defaults to the current calendar month (UTC) when from/to are omitted.



## OpenAPI

````yaml nodeapi/openapi/admin-api.json GET /usage
openapi: 3.1.0
info:
  description: |-
    Programmatic, API-key-authenticated surface for managing
    Validation Cloud RPC endpoints and retrieving usage. Only the
    currently-implemented endpoints are documented; the broader PRD
    surface is intentionally omitted until served.

    `/admin/v1` is a strict contract — breaking changes are made
    under `/admin/v2`, never in place. Clients branch on the stable
    `error.code` enum, not on HTTP status alone.
  title: Validation Cloud Node API — Admin API
  version: 1.0.0
servers:
  - url: https://api.validationcloud.io/admin/v1
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /usage:
    get:
      tags:
        - Usage
      summary: Team-wide compute-unit usage
      description: >-
        Aggregated compute-unit usage for the team the admin key is bound to.
        Defaults to the current calendar month (UTC) when from/to are omitted.
      parameters:
        - description: Inclusive window start, RFC3339
          in: query
          name: from
          schema:
            format: date-time
            type: string
        - description: Exclusive window end, RFC3339
          in: query
          name: to
          schema:
            format: date-time
            type: string
        - description: >-
            Bucket size. Max window per granularity: HOUR 7d, DAY 92d,
            WEEK/MONTH 366d; at most 750 buckets per request.
          in: query
          name: granularity
          schema:
            default: DAY
            enum:
              - HOUR
              - DAY
              - WEEK
              - MONTH
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/admin.usageResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/admin.errorEnvelope'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/admin.errorEnvelope'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/admin.errorEnvelope'
          description: Internal Server Error
      security:
        - AdminApiKey: []
components:
  schemas:
    admin.usageResponse:
      properties:
        compute_units:
          example: 22
          format: int64
          type: integer
        from:
          format: date-time
          type: string
        series:
          items:
            $ref: '#/components/schemas/adminapi.UsagePoint'
          type: array
          uniqueItems: false
        to:
          format: date-time
          type: string
      type: object
    admin.errorEnvelope:
      properties:
        error:
          $ref: '#/components/schemas/admin.errorBody'
      type: object
    adminapi.UsagePoint:
      properties:
        compute_units:
          example: 15
          format: int64
          type: integer
        time:
          format: date-time
          type: string
      type: object
    admin.errorBody:
      properties:
        code:
          enum:
            - unauthorized
            - forbidden
            - invalid_request
            - not_found
            - endpoint_limit_reached
            - plan_not_eligible
            - rate_limited
            - internal_error
          example: invalid_request
          type: string
        message:
          example: from must be an RFC3339 timestamp
          type: string
      type: object
  securitySchemes:
    AdminApiKey:
      description: >-
        Admin API key under the `ApiKey` scheme: `Authorization: ApiKey
        vc_adm_...`. Each key is bound to one team and carries a READ or WRITE
        scope; the usage endpoints require only READ.
      in: header
      name: Authorization
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.