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

# Get Analytics Overview

> Get analytics overview with time-series data and summary cards



## OpenAPI

````yaml GET /analytics/overview
openapi: 3.1.0
info:
  title: RevRing Voice AI API
  description: >-
    RevRing Voice AI platform API for managing AI voice agents, phone calls, SIP
    trunks, and analytics. Build intelligent voice applications that can handle
    inbound and outbound phone calls with AI-powered conversational agents.
  version: 1.0.0
  contact:
    name: RevRing Support
    url: https://revring.ai
servers:
  - url: https://api.revring.ai/v1
    description: Production API
security:
  - apiKeyAuth: []
tags:
  - name: Messaging Connections
    description: Connect messaging providers so agents can send text messages
  - name: Messages
    description: Send text messages and read your message log
  - name: Conversations
    description: List and clear managed conversation threads
  - name: SIP Trunks
    description: Manage SIP trunks for connecting agents to the phone network
  - name: Agents
    description: Manage AI voice agents and their configuration
  - name: Agent Folders
    description: Organize agents into folders for dashboard navigation
  - name: Calls
    description: Manage and query phone calls
  - name: Analytics
    description: Get analytics and metrics about your calls
  - name: Knowledge Bases
    description: >-
      Manage knowledge bases and sources for agent retrieval-augmented
      generation
  - name: Test Suites
    description: Manage test suites, test cases, and test runs for agent evaluation
  - name: Voices
    description: Browse the voices available to your organization for agent speech
paths:
  /analytics/overview:
    get:
      tags:
        - Analytics
      summary: Get Analytics Overview
      description: Get analytics overview with time-series data and summary cards
      operationId: getAnalyticsOverview
      parameters:
        - name: from
          in: query
          required: true
          description: Start date (ISO 8601)
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: End date (ISO 8601)
          schema:
            type: string
            format: date-time
        - name: agentId
          in: query
          description: Filter by agent ID
          schema:
            type: string
            format: uuid
        - name: tz
          in: query
          description: Timezone (IANA format)
          schema:
            type: string
            default: UTC
        - name: bucket
          in: query
          description: Time bucket granularity
          schema:
            type: string
            enum:
              - auto
              - hour
              - day
              - month
            default: auto
      responses:
        '200':
          description: Analytics data
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AnalyticsOverview'
                required:
                  - data
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/BillingInactiveError'
components:
  schemas:
    AnalyticsOverview:
      type: object
      properties:
        filters:
          type: object
          properties:
            from:
              type: string
              format: date-time
            to:
              type: string
              format: date-time
            tz:
              type: string
              description: IANA timezone
            agentId:
              type: string
              format: uuid
            bucket:
              type: string
              enum:
                - hour
                - day
                - month
        cards:
          type: object
          properties:
            totalCalls:
              type: object
              properties:
                label:
                  type: string
                  example: Total Calls
                value:
                  type: integer
            totalCost:
              type: object
              properties:
                label:
                  type: string
                  example: Total Cost
                valueUsd:
                  type: number
                valueCents:
                  type: integer
            averageDuration:
              type: object
              properties:
                label:
                  type: string
                  example: Average Duration
                valueSeconds:
                  type: number
            totalTransfers:
              type: object
              properties:
                label:
                  type: string
                  example: Total Transfers
                value:
                  type: integer
        series:
          type: array
          items:
            type: object
            properties:
              ts:
                type: string
                format: date-time
                description: Bucket timestamp
              totalCalls:
                type: integer
              totalTransfers:
                type: integer
              averageDurationSeconds:
                type: number
              billableSeconds:
                type: integer
              totalCostCents:
                type: integer
              totalCostUsd:
                type: number
        activeCalls:
          type: integer
          description: Current active calls (not affected by filters)
      required:
        - filters
        - cards
        - series
        - activeCalls
  responses:
    BadRequestError:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: invalid_body
              details:
                type: object
    UnauthorizedError:
      description: Authentication required or API key invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: unauthorized
    BillingInactiveError:
      description: Subscription inactive or billing issue
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: billing_inactive
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Generate API keys from the RevRing
        dashboard.

````