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

# Get Platform Analytics

> Retrieves comprehensive platform analytics including performance metrics and summaries.

Return high-level platform analytics for calls in the workspace. Use this endpoint for overview dashboards and executive summaries.

## Common filters

* `start_date` and `end_date` for the reporting period.
* `agent_id` for one assistant.
* `bulk_list_id` for one campaign.
* `voicemail` when voicemail-heavy traffic should be included or separated.

## Developer guidance

Use this endpoint for top-level numbers, then use drill-down analytics or call history when a user clicks into a specific campaign, number, or status bucket.


## OpenAPI

````yaml get /analytics/platform-analytics
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    This is the documentation for the Ringg AI APIs. The Ringg AI API follows
    RESTful principles, making it intuitive and easy to integrate with your
    applications. All API requests should be made to the base URL. The API
    accepts and returns data in JSON format. Ensure your requests include the
    appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /analytics/platform-analytics:
    get:
      tags:
        - analytics
      summary: Get Platform Analytics
      description: >-
        Retrieves comprehensive platform analytics including performance metrics
        and summaries.
      operationId: getPlatformAnalytics
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
        - name: start_date
          in: query
          description: Start date for analytics filter (YYYY-MM-DD format)
          required: false
          schema:
            type: string
            default: '2025-09-25'
            example: '2025-09-25'
        - name: end_date
          in: query
          description: End date for analytics filter (YYYY-MM-DD format)
          required: false
          schema:
            type: string
            default: '2025-09-25'
            example: '2025-09-25'
        - name: agent_id
          in: query
          description: Filter by specific agent ID
          required: false
          schema:
            type: string
            example: 123e4567-e89b-12d3-a456-426614174000
        - name: bulk_list_id
          in: query
          description: Filter by specific bulk list/campaign ID
          required: false
          schema:
            type: string
            example: 123e4567-e89b-12d3-a456-426614174000
        - name: voicemail
          in: query
          description: Filter by voicemail status
          required: false
          schema:
            type: boolean
            example: false
      responses:
        '200':
          description: Platform analytics retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  performance_metrics:
                    type: object
                    description: Performance metrics by different categories
                  metrics_summary:
                    type: object
                    description: Summary of key metrics
                  cached:
                    type: boolean
                    description: Whether the response was served from cache
        '401':
          description: Unauthorized - Invalid or missing authentication.
        '500':
          description: Internal Server Error.

````