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

# Get Usage History

> Your organization's conversations with their usage, paginated.



## OpenAPI

````yaml /api-reference/openapi.en.json get /api/v1/usage/conversations
openapi: 3.1.0
info:
  title: Brosbots API
  description: >
    The public Brosbots REST API. Build and manage voice agents, run outbound

    campaigns, read calls and usage, and manage phone numbers, tools,

    knowledge bases and integrations.


    ## Authentication


    Every request must include your organization's API key in the

    `X-API-Key` header:


    ```

    X-API-Key: bb_live_...

    ```


    You create and revoke keys in the dashboard:

    click your account in the bottom-left corner of the sidebar, then **Brosbots
    API**.


    ## Base URL


    ```

    https://app.brosbots.com/api/v1

    ```


    ## Conventions


    - Request and response bodies are JSON (`Content-Type: application/json`).

    - Timestamps are ISO 8601 with a timezone.

    - Lists are paginated with `page` / `limit` parameters; responses include
      `total_count` / `total_pages`.
    - Errors use standard HTTP status codes with a JSON body:
      `{"detail": "a human-readable reason"}`.
    - `{agent_id}` accepts the agent's public ID (`agent_...`) or its number.


    ## Limits


    There is no fixed per-key request-rate limit today. `429` comes from the

    calling endpoints (`POST /agents/{agent_id}/calls` and

    `POST /triggers/{trigger_id}/calls`) when every outbound channel is busy;
    its `Retry-After` header says how many seconds to wait. Handle `429`

    generally: wait as long as `Retry-After` says, or back off exponentially
    when

    it is absent. A request-rate limit may be introduced.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
paths:
  /api/v1/usage/conversations:
    get:
      tags:
        - Usage & Analytics
      summary: Get Usage History
      description: Your organization's conversations with their usage, paginated.
      operationId: get_usage_conversations
      parameters:
        - name: start_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: ISO format date string
          description: ISO format date string
        - name: end_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: ISO format date string
          description: ISO format date string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            default: 50
        - name: filters
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: JSON string of filters
          description: JSON string of filters
        - name: agent_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^agent_[A-Za-z0-9]{20}$
              - type: integer
              - type: 'null'
          description: >-
            Only this agent's conversations: its public ID (`agent_...`) or
            number.
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageHistoryResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UsageHistoryResponse:
      properties:
        runs:
          items:
            $ref: '#/components/schemas/ConversationUsageResponse'
          type: array
        total_credits:
          type: number
        total_duration_seconds:
          type: integer
        total_count:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        total_pages:
          type: integer
      type: object
      required:
        - runs
        - total_credits
        - total_duration_seconds
        - total_count
        - page
        - limit
        - total_pages
      title: UsageHistoryResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
      title: HTTPValidationError
    ConversationUsageResponse:
      properties:
        id:
          type: integer
        workflow_id:
          type: integer
        workflow_name:
          anyOf:
            - type: string
            - type: 'null'
        name:
          type: string
        created_at:
          type: string
        credit_usage:
          type: number
        call_duration_seconds:
          type: integer
        recording_url:
          anyOf:
            - type: string
            - type: 'null'
        transcript_url:
          anyOf:
            - type: string
            - type: 'null'
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
        disposition:
          anyOf:
            - type: string
            - type: 'null'
        mode:
          anyOf:
            - type: string
            - type: 'null'
        channel:
          anyOf:
            - type: string
            - type: 'null'
        channel_origin:
          anyOf:
            - type: string
            - type: 'null'
        initial_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
        gathered_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
        charge_usd:
          anyOf:
            - type: number
            - type: 'null'
        billable_minutes:
          type: integer
          default: 0
        billed_amount:
          anyOf:
            - type: number
            - type: 'null'
        billing_note:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - id
        - workflow_id
        - workflow_name
        - name
        - created_at
        - credit_usage
        - call_duration_seconds
      title: ConversationUsageResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your organization's API key (account in the bottom-left of the dashboard
        → Brosbots API).

````

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