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

# Get usage by model

> Summarize model-level usage over a reporting period.

Supply an IANA `timezone`, such as `Europe/Dublin`. Use `period=7d` or `30d`, or `custom` with `start` and `end` in `YYYY-MM-DD` format. Invalid periods/date ranges return `400`. Use the same range and timezone across related charts. The default period is 30 days. Optional `workflow_id` narrows the results; provider/model fields identify each aggregate.


## OpenAPI

````yaml GET /api/v1/organizations/reports/usage-by-model
openapi: 3.1.0
info:
  title: Bandwidth Agent Builder API
  version: v1
  description: >-
    Manage agents, place calls, and retrieve conversation results in your
    workspace.
servers:
  - url: https://agents.labs.bandwidth.com
    description: Workspace API
security: []
paths:
  /api/v1/organizations/reports/usage-by-model:
    get:
      tags:
        - reports
      summary: Get usage by model
      description: >-
        **Authorization:** Accepts a Labs OAuth bearer token or a Labs API key.
        Workspace-scoped resources require membership in the requested
        workspace.


        Summarize model-level usage over a reporting period.
      operationId: >-
        get_analytics_usage_by_model_api_v1_organizations_reports_usage_by_model_get
      parameters:
        - in: query
          name: period
          required: false
          schema:
            default: 30d
            title: Period
            type: string
        - in: query
          name: timezone
          required: true
          schema:
            title: Timezone
            type: string
        - in: query
          name: start
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Start
        - in: query
          name: end
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: End
        - in: query
          name: workflow_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Workflow Id
        - description: >-
            Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace
            ID to access. The key owner must be a current member. Missing or
            invalid IDs return 400; non-member workspaces return 403. Not
            required for bearer authentication, which uses the user's selected
            workspace.
          in: header
          name: X-VOAI-ORGANIZATION-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Required with X-BW-LABS-AGENTS-API-KEY: the positive local
              workspace ID to access. The key owner must be a current member.
              Missing or invalid IDs return 400; non-member workspaces return
              403. Not required for bearer authentication, which uses the user's
              selected workspace.
            title: X-Voai-Organization-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsUsageByModelResponse'
          description: Successful Response
        '400':
          description: Invalid request or missing/invalid workspace header with an API key.
        '401':
          description: Missing, invalid, or expired credential.
        '403':
          description: >-
            The account lacks access to the workspace, resource, or required
            role.
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - LabsAuth: []
        - LabsApiKey: []
components:
  schemas:
    AnalyticsUsageByModelResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/AnalyticsUsageByModelItem'
          title: Models
          type: array
        period:
          title: Period
          type: string
        total_tokens:
          title: Total Tokens
          type: integer
      required:
        - period
        - total_tokens
        - models
      title: AnalyticsUsageByModelResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AnalyticsUsageByModelItem:
      properties:
        cache_read_tokens:
          title: Cache Read Tokens
          type: integer
        calls:
          title: Calls
          type: integer
        completion_tokens:
          title: Completion Tokens
          type: integer
        model:
          title: Model
          type: string
        processor:
          title: Processor
          type: string
        prompt_tokens:
          title: Prompt Tokens
          type: integer
        share_pct:
          title: Share Pct
          type: number
        total_tokens:
          title: Total Tokens
          type: integer
      required:
        - processor
        - model
        - calls
        - prompt_tokens
        - completion_tokens
        - total_tokens
        - cache_read_tokens
        - share_pct
      title: AnalyticsUsageByModelItem
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    LabsAuth:
      description: >-
        Bandwidth Labs OAuth access token. Uses the user's selected workspace;
        the workspace header is not required. Do not also send an API key.
        Bearer-only operations may additionally require the Labs `super_user`
        role.
      scheme: bearer
      type: http
    LabsApiKey:
      description: >-
        Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a
        positive local workspace ID belonging to the key owner. Access follows
        the owner's current workspace role. Do not also send a bearer token. API
        keys cannot access bearer-only or Labs `super_user` operations.
      in: header
      name: X-BW-LABS-AGENTS-API-KEY
      type: apiKey

````

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