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

# Get Analytics

> Aggregated analytics for the authenticated user's company over a time period: totals, line-chart series, monitoring breakdowns, and a quality-score split. Pass `period=custom` together with `start_date` and `end_date` for a bespoke window.



## OpenAPI

````yaml GET /analytics/
openapi: 3.1.0
info:
  title: Outbox AI API
  description: API for managing AI agents (chatbots and voicebots) on the Outbox platform
  version: 1.0.0
servers:
  - url: https://api.getoutbox.ai
security: []
paths:
  /analytics/:
    get:
      tags:
        - analytics
      summary: Get Analytics
      description: >-
        Aggregated analytics for the authenticated user's company over a time
        period: totals, line-chart series, monitoring breakdowns, and a
        quality-score split. Pass `period=custom` together with `start_date` and
        `end_date` for a bespoke window.
      operationId: analytics_retrieve
      parameters:
        - in: header
          name: X-User-Timezone
          schema:
            type: string
          description: IANA timezone name (e.g. `Australia/Perth`). Defaults to UTC.
        - in: query
          name: agent
          schema:
            type: string
            default: all
          description: Agent UUID, or `all` for every agent in scope.
        - in: query
          name: end_date
          schema:
            type: string
            format: date
          description: ISO date (YYYY-MM-DD). Required when `period=custom`.
        - in: query
          name: period
          schema:
            type: string
            enum:
              - custom
              - daily
              - monthly
              - weekly
              - yearly
            default: monthly
          description: >-
            Predefined time window. Use `custom` together with
            `start_date`/`end_date`.
        - in: query
          name: start_date
          schema:
            type: string
            format: date
          description: ISO date (YYYY-MM-DD). Required when `period=custom`.
        - in: query
          name: type
          schema:
            type: string
            enum:
              - all
              - chat
              - voice
            default: all
          description: >-
            Filter by agent type. `all` may auto-resolve to `chat` or `voice` if
            only one type produced threads in the window.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsResponse'
          description: Aggregated analytics payload.
      security:
        - jwtAuth: []
        - {}
components:
  schemas:
    AnalyticsResponse:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/TypeEnum'
        main:
          type: object
          additionalProperties: {}
          description: >-
            Top-line totals for the period (conversations, cost, profit, etc.)
            and percentage deltas vs the previous period.
        lineChartData:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: Time-series buckets keyed by hour/day/month depending on `period`.
        statisticsData:
          type: object
          additionalProperties: {}
          description: Sub-totals broken out by status, agent, etc.
        monitoring:
          type: object
          additionalProperties: {}
          description: >-
            Quality-score split: `excellent`, `good`, `poor` with `count` and
            `percentage`.
      required:
        - lineChartData
        - main
        - monitoring
        - statisticsData
        - type
    TypeEnum:
      enum:
        - all
        - chat
        - voice
      type: string
      description: |-
        * `all` - all
        * `chat` - chat
        * `voice` - voice
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````