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

# Get Dashboard Data

> Retrieve comprehensive dashboard analytics including call statistics, costs, and performance metrics



## OpenAPI

````yaml get /api/v1/dashboard
openapi: 3.0.3
info:
  title: Vodex API
  description: >-
    Comprehensive API documentation for Vodex.ai - AI-powered telecalling and
    voice automation platform. Manage projects, campaigns, audiences, and
    analyze call data with our robust API suite.
  termsOfService: https://vodex.ai/terms-of-use
  contact:
    name: Vodex Developer Support
    email: developers@vodex.ai
    url: https://vodex.ai/support
  license:
    name: Proprietary
    url: https://vodex.ai/license
  version: 2.0.0
  x-logo:
    url: >-
      https://firebasestorage.googleapis.com/v0/b/lilchirp-io.appspot.com/o/logo.png?alt=media&token=3178b5f8-84ff-426d-ba89-8088fa2c4d92
    backgroundColor: '#FFFFFF'
    altText: Vodex
servers:
  - url: https://api.vodex.ai
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: >-
      Vodex uses API Key for authentication. If you are looking for the API
      Key(s) for your account, please fill the [Google
      Form](https://docs.google.com/forms/d/e/1FAIpQLSddntmCxrGt2TyKwPuXiDciLJC_dCMolSqU8qrikTNY00vr1A/viewform)
      with all the required details.
  - name: Projects
    description: >-
      Manage different projects in a single account. Create isolated bots for
      different use cases with comprehensive project management capabilities.
  - name: Audience
    description: >-
      Manage target audience information including names, mobile numbers, and
      custom fields for your calling campaigns.
  - name: Agent Setting
    description: >-
      Configure AI agents with custom prompts, greetings, context, and
      conversation flows for your telecalling campaigns.
  - name: Campaign
    description: >-
      Create, manage, and monitor telecalling campaigns with comprehensive
      campaign management tools.
  - name: Campaign Runs
    description: >-
      Track and analyze individual campaign execution runs with detailed
      performance metrics.
  - name: Call Trigger
    description: >-
      Trigger automated calls and manage call execution with custom parameters
      and real-time control.
  - name: Call Setting
    description: >-
      Configure call settings including caller ID, transfer numbers, voice
      settings, and call behavior parameters.
  - name: Advance Settings
    description: >-
      Advanced configuration options for API keys, rule IDs, account settings,
      and client configurations.
  - name: Appointment Settings
    description: >-
      Manage appointment booking settings, slot availability, and scheduling
      configurations for your campaigns.
  - name: Recording
    description: >-
      Upload and manage audio recordings for use in your telecalling campaigns
      and voice interactions.
  - name: Dashboard
    description: >-
      Access comprehensive analytics, metrics, and dashboard data for monitoring
      campaign performance.
  - name: Run Campaign Details
    description: >-
      Detailed analytics and reporting for individual campaign runs with
      filtering and pagination support.
  - name: Analyze
    description: >-
      AI-powered call analysis tools for generating summaries and extracting
      insights from call transcripts.
  - name: Twilio
    description: >-
      Twilio integration for caller ID verification and OTP management for
      enhanced call security.
externalDocs:
  description: Find out more about Vodex
  url: https://vodex.ai
paths:
  /api/v1/dashboard:
    get:
      tags:
        - Dashboard
      summary: Get Dashboard Data
      description: >-
        Retrieve comprehensive dashboard analytics including call statistics,
        costs, and performance metrics
      operationId: getDashboardController
      parameters:
        - name: Authorization
          in: header
          description: API Key
          required: true
          schema:
            type: string
        - name: dburl
          in: header
          description: Database URL - unique account identifier
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  data:
                    type: object
                    properties:
                      totalDuration:
                        type: integer
                      totalCost:
                        type: string
                      balance:
                        type: string
                      onHoldBalance:
                        type: string
                      remainingMinutes:
                        type: integer
                      totalCallsMade:
                        type: integer
                      callStatus:
                        required:
                          - totalConnected
                          - totalEnded
                          - totalFailed
                          - undefined
                        type: object
                        properties:
                          totalFailed:
                            type: integer
                          totalEnded:
                            type: integer
                          undefined:
                            type: integer
                          totalConnected:
                            type: integer
        default:
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: API Key authentication. Pass your API key in the Authorization header.
      name: Authorization
      in: header

````