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

# Get project usage metrics

> Returns request, error, token, latency and permitted spend metrics grouped by hour or day. Requires usage:read-metrics.



## OpenAPI

````yaml /api-reference/openapi.json get /usage/metrics
openapi: 3.0.0
info:
  title: AIRCTRL API
  description: >-
    Programmatic access to AIRCTRL. Record values are encrypted by the client,
    so the API stores ciphertext and encrypted keys instead of plaintext record
    values.
  version: '1'
  contact: {}
servers:
  - url: https://api.airctrl.dev/v1
    description: Production
security: []
tags:
  - name: Context
    description: Find the accounts available to the caller.
  - name: Projects
    description: Create and manage projects.
  - name: Records
    description: Store and use client-encrypted records.
  - name: Audit
    description: Read record activity and access history.
  - name: Providers
    description: Discover supported AI providers.
  - name: Provider Credentials
    description: Manage encrypted provider credentials.
  - name: Gateways
    description: Create and operate AI gateways.
  - name: Usage
    description: Read gateway usage and spend data.
  - name: Service Accounts
    description: Read Service Account metadata and grant records.
paths:
  /usage/metrics:
    get:
      tags:
        - Usage
      summary: Get project usage metrics
      description: >-
        Returns request, error, token, latency and permitted spend metrics
        grouped by hour or day. Requires usage:read-metrics.
      operationId: UsageController_metrics
      parameters: []
      responses:
        '200':
          description: Project usage metrics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/UsageMetrics'
                required:
                  - ok
                  - data
                additionalProperties: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - personal-access-token: []
components:
  schemas:
    UsageMetrics:
      type: object
      properties:
        bucket:
          type: string
          enum:
            - hour
            - day
        since:
          type: string
          format: date-time
        can_read_spend:
          type: boolean
        series:
          type: array
          items:
            type: object
            properties:
              ts:
                type: string
                format: date-time
              requests:
                type: integer
              errors:
                type: integer
              tokens:
                type: integer
              spend:
                type: string
                nullable: true
              p50_ms:
                type: number
                nullable: true
              p95_ms:
                type: number
                nullable: true
              p99_ms:
                type: number
                nullable: true
            additionalProperties: false
            required:
              - ts
              - requests
              - errors
              - tokens
              - spend
              - p50_ms
              - p95_ms
              - p99_ms
        totals:
          type: object
          properties:
            requests:
              type: integer
              minimum: 0
            errors:
              type: integer
              minimum: 0
            error_rate:
              type: number
              minimum: 0
            tokens:
              type: integer
              minimum: 0
            spend:
              type: string
              nullable: true
            p95_ms:
              type: number
              nullable: true
          additionalProperties: false
          required:
            - requests
            - errors
            - error_rate
            - tokens
            - spend
            - p95_ms
        prev_totals:
          type: object
          properties:
            requests:
              type: integer
              minimum: 0
            errors:
              type: integer
              minimum: 0
            error_rate:
              type: number
              minimum: 0
            tokens:
              type: integer
              minimum: 0
            spend:
              type: string
              nullable: true
            p95_ms:
              type: number
              nullable: true
          additionalProperties: false
          required:
            - requests
            - errors
            - error_rate
            - tokens
            - spend
            - p95_ms
        top_models:
          type: array
          items:
            type: object
            properties:
              model:
                type: string
              requests:
                type: integer
              spend:
                type: string
                nullable: true
            additionalProperties: false
            required:
              - model
              - requests
              - spend
        top_principals:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              principal_type:
                type: string
                enum:
                  - user
                  - service_account
                nullable: true
              requests:
                type: integer
              spend:
                type: string
                nullable: true
            additionalProperties: false
            required:
              - label
              - principal_type
              - requests
              - spend
      additionalProperties: false
      required:
        - bucket
        - since
        - can_read_spend
        - series
        - totals
        - prev_totals
        - top_models
        - top_principals
    ErrorEnvelope:
      type: object
      properties:
        ok:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable error category.
            message:
              type: string
              description: Plain-language reason for the failure.
            details:
              description: Optional validation or error details.
          additionalProperties: false
          required:
            - code
            - message
        requestId:
          type: string
          description: Request identifier to include when contacting support.
      additionalProperties: false
      required:
        - ok
        - error
      description: Standard AIRCTRL error response.
  responses:
    Unauthorized:
      description: >-
        The token is missing, invalid, expired or cannot authenticate this
        request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            ok: false
            error:
              code: unauthorized
              message: Authentication is required
            requestId: req_example
    Forbidden:
      description: >-
        The authenticated principal does not have the required permission or
        resource access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            ok: false
            error:
              code: forbidden
              message: not_authorized
            requestId: req_example
    RateLimited:
      description: The caller exceeded the API request limit. Wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            ok: false
            error:
              code: rate_limited
              message: Too many requests
            requestId: req_example
    InternalError:
      description: >-
        AIRCTRL could not complete the request. Retry later and keep the request
        ID for support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            ok: false
            error:
              code: internal_error
              message: Internal server error
            requestId: req_example
  securitySchemes:
    personal-access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Human personal access token (`sk-actrl-pat-...`).

````