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

# Get a usage time series

> Owner or billing role. from and to are both required; bucket is hour or day and defaults to day. Only non-empty buckets are returned. estimated_cents is either present on every point or absent from every point: one price read prices the whole series.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/organizations/{organization_id}/usage/series
openapi: 3.1.0
info:
  title: Bonya Compute REST API
  version: 0.1.0
  description: >
    Public REST and WebSocket surface on TApi behind Caddy. Non-2xx responses
    are RFC 9457 application/problem+json with a stable machine-readable code.
    WebSocket endpoints are HTTP GET upgrades; their options travel in the START
    frame, never in query strings.
servers:
  - url: https://api.bonya.ai
    description: Production
security:
  - personalApiKey: []
  - supabaseJwt: []
tags:
  - name: Sandboxes
    description: Create, look up, list, pause, fork, snapshot, and delete sandboxes.
  - name: Snapshots
    description: Named point-in-time copies of a sandbox that new sandboxes can start from.
  - name: Templates
    description: Saved, versioned launch configurations for sandboxes.
  - name: Registry Connections
    description: Credentials for pulling private container images.
  - name: Secrets
    description: Write-only secrets and secret sets injected into sandboxes and jobs.
  - name: Previews
    description: Expose a sandbox port as an HTTPS URL.
  - name: Exec
    description: Run a command in a sandbox, buffered or over a TTY.
  - name: Sessions
    description: Named, persistent command sessions that outlive a connection.
  - name: Filesystem
    description: Read, write, and manage files inside a sandbox.
  - name: Jobs
    description: Managed, tracked runs of a command or script.
  - name: Job Schedules
    description: Cron, interval, or one-shot timing wrapped around a job.
  - name: Organizations
    description: Organization membership, administration and usage reporting.
  - name: Invitations
    description: Invite members to an organization and accept invitations.
  - name: API Keys
    description: Personal API key management.
  - name: Device Login
    description: Browser-based login for the CLI.
paths:
  /v1/organizations/{organization_id}/usage/series:
    get:
      tags:
        - Organizations
      summary: Get a usage time series
      description: >-
        Owner or billing role. from and to are both required; bucket is hour or
        day and defaults to day. Only non-empty buckets are returned.
        estimated_cents is either present on every point or absent from every
        point: one price read prices the whole series.
      operationId: getOrganizationUsageSeries
      parameters:
        - $ref: '#/components/parameters/OrganizationID'
        - name: from
          in: query
          required: true
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          schema:
            type: string
            format: date-time
        - name: bucket
          in: query
          schema:
            type: string
            enum:
              - hour
              - day
            default: day
      responses:
        '200':
          description: Usage series
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageSeries'
        default:
          $ref: '#/components/responses/Problem'
      security:
        - supabaseJwt: []
components:
  parameters:
    OrganizationID:
      name: organization_id
      in: path
      required: true
      schema:
        type: string
  schemas:
    UsageSeries:
      type: object
      required:
        - currency
        - period
        - bucket
        - points
        - degraded
      properties:
        currency:
          type: string
        period:
          $ref: '#/components/schemas/BillingPeriod'
        bucket:
          type: string
          enum:
            - hour
            - day
        points:
          type: array
          description: Only non-empty buckets are included.
          items:
            $ref: '#/components/schemas/UsageSeriesPoint'
        degraded:
          type: array
          items:
            $ref: '#/components/schemas/Degradation'
    BillingPeriod:
      type: object
      required:
        - from
        - to
      properties:
        from:
          type: string
          format: date-time
        to:
          type: string
          format: date-time
    UsageSeriesPoint:
      type: object
      required:
        - from
        - to
        - compute_seconds
        - storage_hours
      properties:
        from:
          type: string
          format: date-time
        to:
          type: string
          format: date-time
        compute_seconds:
          type: number
        storage_hours:
          type: number
        estimated_cents:
          type: integer
          format: int64
          description: >-
            Present on every point or absent from every point: one price read
            prices the whole series.
    Degradation:
      type: string
      enum:
        - balance
        - prices
        - limits
        - offers
      description: >-
        One provider-dependent enrichment that was attempted and did not produce
        a usable value. Never emitted for a value that is legitimately absent.
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
  responses:
    Problem:
      description: RFC 9457 problem
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    personalApiKey:
      type: http
      scheme: bearer
      description: >-
        Personal byk_ API key; user-principal, resolved to a tenant by org
        context.
    supabaseJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Supabase-issued session JWT; required for org, invite, and key
        management.

````

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