> ## 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 analytics overview

> Retrieve workspace analytics totals and comparison data.

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. Optional `workflow_id` limits the results to one agent.


## OpenAPI

````yaml GET /api/v1/organizations/reports/overview
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/overview:
    get:
      tags:
        - reports
      summary: Get analytics overview
      description: >-
        **Authorization:** Accepts a Labs OAuth bearer token or a Labs API key.
        Workspace-scoped resources require membership in the requested
        workspace.


        Retrieve workspace analytics totals and comparison data.
      operationId: get_analytics_overview_api_v1_organizations_reports_overview_get
      parameters:
        - description: 'One of: 7d, 30d, custom'
          in: query
          name: period
          required: false
          schema:
            default: 7d
            description: 'One of: 7d, 30d, custom'
            title: Period
            type: string
        - description: IANA timezone (e.g., 'America/New_York')
          in: query
          name: timezone
          required: true
          schema:
            description: IANA timezone (e.g., 'America/New_York')
            title: Timezone
            type: string
        - description: YYYY-MM-DD (required for custom)
          in: query
          name: start
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: YYYY-MM-DD (required for custom)
            title: Start
        - description: YYYY-MM-DD (required for custom)
          in: query
          name: end
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: YYYY-MM-DD (required for custom)
            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/AnalyticsOverviewResponse'
          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:
    AnalyticsOverviewResponse:
      properties:
        end_utc:
          title: End Utc
          type: string
        period:
          title: Period
          type: string
        start_utc:
          title: Start Utc
          type: string
        summary:
          $ref: '#/components/schemas/AnalyticsOverviewSummary'
        timezone:
          title: Timezone
          type: string
        workflow_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Workflow Id
      required:
        - period
        - timezone
        - start_utc
        - end_utc
        - workflow_id
        - summary
      title: AnalyticsOverviewResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AnalyticsOverviewSummary:
      properties:
        avg_call_duration_seconds:
          title: Avg Call Duration Seconds
          type: number
        avg_cast_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Avg Cast Score
        avg_cast_score_delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Avg Cast Score Delta Pct
        avg_tokens_per_call:
          title: Avg Tokens Per Call
          type: number
        calls_delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Calls Delta Pct
        calls_prior_period:
          title: Calls Prior Period
          type: integer
        calls_total:
          title: Calls Total
          type: integer
        cast_scored_count:
          default: 0
          title: Cast Scored Count
          type: integer
        connect_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Connect Rate Pct
        cost_per_connected_call_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost Per Connected Call Usd
        end_call_tool_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: End Call Tool Rate Pct
        median_call_duration_seconds:
          title: Median Call Duration Seconds
          type: number
        negative_sentiment_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Negative Sentiment Rate Pct
        neutral_sentiment_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Neutral Sentiment Rate Pct
        p90_call_duration_seconds:
          title: P90 Call Duration Seconds
          type: number
        positive_sentiment_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Positive Sentiment Rate Pct
        priced_runs:
          default: 0
          title: Priced Runs
          type: integer
        qualified_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Qualified Rate Pct
        repeat_dial_phone_numbers:
          title: Repeat Dial Phone Numbers
          type: integer
        repeat_dial_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Repeat Dial Rate Pct
        spend_delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Spend Delta Pct
        success_rate_delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Success Rate Delta Pct
        success_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Success Rate Pct
        talk_time_delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Talk Time Delta Pct
        talk_time_seconds:
          title: Talk Time Seconds
          type: number
        tokens_per_minute:
          anyOf:
            - type: number
            - type: 'null'
          title: Tokens Per Minute
        total_spend_usd:
          title: Total Spend Usd
          type: number
        total_tokens_delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Total Tokens Delta Pct
        total_tokens_used:
          title: Total Tokens Used
          type: number
        transfer_attempt_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Transfer Attempt Rate Pct
        transfer_success_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Transfer Success Rate Pct
        unique_phone_numbers:
          title: Unique Phone Numbers
          type: integer
        voicemail_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Voicemail Rate Pct
      required:
        - calls_total
        - calls_prior_period
        - talk_time_seconds
        - avg_call_duration_seconds
        - median_call_duration_seconds
        - p90_call_duration_seconds
        - total_spend_usd
        - avg_tokens_per_call
        - total_tokens_used
        - unique_phone_numbers
        - repeat_dial_phone_numbers
      title: AnalyticsOverviewSummary
      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.