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

# Get your usage

> Your account's charged tool calls in a time range: tool calls that finished with a result, counted when Pomerado accepted them, from (inclusive) to (exclusive). With group_by integration, each integration's calls too. With group_by member, each member's calls and integrations created (successful builds) in the range: a Business Owner or Admin sees every member, including anyone who has left the team but used the account in the range, and a Member sees only their own row. coverage.complete says whether the whole range lies within recorded history.

**Authentication:** `Authorization: Bearer <token>` with Dashboard session, Pomerado MCP OAuth token, API key.

**Permission:** `usage:read`.

**Effect:** Read: changes nothing.

**Errors:** [`invalid_request`](/errors#invalid_request) (400), [`unauthorized`](/errors#unauthorized) (401), [`reauthentication_required`](/errors#reauthentication_required) (401), [`forbidden`](/errors#forbidden) (403), [`internal_error`](/errors#internal_error) (500), [`temporarily_unavailable`](/errors#temporarily_unavailable) (503). Every error has the same [envelope](/errors).


## OpenAPI

````yaml /api-reference/openapi.json get /v1/usage
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: logins
    x-group: Logins
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: support
    x-group: Support
paths:
  /v1/usage:
    get:
      tags:
        - usage
      summary: Get your usage
      description: >-
        Your account's charged tool calls in a time range: tool calls that
        finished with a result, counted when Pomerado accepted them, from
        (inclusive) to (exclusive). With group_by integration, each
        integration's calls too. With group_by member, each member's calls and
        integrations created (successful builds) in the range: a Business Owner
        or Admin sees every member, including anyone who has left the team but
        used the account in the range, and a Member sees only their own row.
        coverage.complete says whether the whole range lies within recorded
        history.
      operationId: usage.get
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            Start of the range, inclusive (default: every call since coverage
            began)
          schema:
            type: string
        - name: to
          in: query
          required: false
          description: 'End of the range, exclusive (default: now)'
          schema:
            type: string
        - name: group_by
          in: query
          required: false
          description: >-
            integration: also list each integration's calls. member: also list
            each member's calls and integrations created; a Business Member gets
            only their own row
          schema:
            type: string
            enum:
              - integration
              - member
      responses:
        '200':
          description: Your usage in the range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageReport'
        '400':
          description: invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    UsageReport:
      type: object
      required:
        - from
        - to
        - as_of
        - calls
        - last_used_at
        - unattributed_calls
        - coverage
      properties:
        from:
          anyOf:
            - type: string
            - type: 'null'
        to:
          type: string
        as_of:
          type: string
        calls:
          type: integer
          description: Charged tool calls in the range
          minimum: 0
        last_used_at:
          anyOf:
            - type: string
            - type: 'null'
        unattributed_calls:
          type: integer
          description: Calls in the range recorded before calls named their integration
          minimum: 0
        coverage:
          type: object
          required:
            - started_at
            - complete
            - attribution_complete
          properties:
            started_at:
              type: string
              description: When usage recording began
            complete:
              type: boolean
              description: The whole range lies within recorded history
            attribution_complete:
              type: boolean
          additionalProperties: false
        groups:
          type: array
          items:
            type: object
            required:
              - integration_id
              - calls
              - last_used_at
            properties:
              integration_id:
                $ref: '#/components/schemas/integration_id'
              calls:
                type: integer
                description: a non-negative number
                minimum: 0
              last_used_at:
                anyOf:
                  - type: string
                  - type: 'null'
            additionalProperties: false
        members:
          type: array
          items:
            type: object
            required:
              - member_id
              - name
              - email
              - role
              - calls
              - integrations_created
              - last_used_at
            properties:
              member_id:
                type: string
                description: The member's WorkOS user ID
              name:
                anyOf:
                  - type: string
                  - type: 'null'
              email:
                anyOf:
                  - type: string
                  - type: 'null'
              role:
                anyOf:
                  - type: string
                    enum:
                      - owner
                      - admin
                      - member
                  - type: 'null'
                description: The member's current role; null once they have left the team
              calls:
                type: integer
                description: Their charged tool calls in the range
                minimum: 0
              integrations_created:
                type: integer
                description: >-
                  Their successful builds in the range: each build that
                  published a tool, including one that added a tool to an
                  existing integration
                minimum: 0
              last_used_at:
                anyOf:
                  - type: string
                  - type: 'null'
                description: Their last charged call in the range
            additionalProperties: false
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
    integration_id:
      type: string
      description: 'an integration ID: int_ and 32 lowercase hex digits'
      examples:
        - int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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