> ## 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.

> ## Agent Instructions
> To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md
> The dashboard labels agents "Assistants"; these docs say "agent". Both mean the same object, identified by agent_id.
> API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only.
> Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling.
> To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md

> Get workspace-level call metrics for a date range, filtered by agent, campaign or voicemail, for overview dashboards and reports built outside Ringg AI.

# Get Platform Analytics

export const RelatedTopics = ({items}) => <div className="not-prose mt-12">
    <div className="text-sm font-medium text-gray-500 dark:text-zinc-400 mb-3">Related topics</div>
    <div className="flex flex-col gap-2.5">
      {items.map(([title, href]) => <a key={href} href={href} className="flex items-center gap-2.5 text-sm text-gray-700 hover:text-gray-950 dark:text-zinc-300 dark:hover:text-white">
          <Icon icon="file-text" size={16} color="currentColor" />
          {title}
        </a>)}
    </div>
  </div>;

## Notes

* For one campaign in detail, call [drill-down analytics](/api-reference/monitoring/analytics/get-drill-down-analytics); for call-level rows, [call history](/api-reference/monitoring/call-history/get-call-history).

<RelatedTopics items={[["Number analytics", "/api-reference/monitoring/analytics/get-number-analytics"]]} />


## OpenAPI

````yaml get /analytics/platform-analytics
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    The Ringg AI REST API. Base URL https://prod-api.ringg.ai/ca/api/v0; send
    your workspace API key in the X-API-KEY header from server-side code only.
    Requests and responses are JSON.
  version: 2.0.0
  contact:
    name: Ringg AI support
    email: admin@ringg.ai
    url: https://docs.ringg.ai
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 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 workspace-level call metrics and a summary of key numbers.
      operationId: getPlatformAnalytics
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        - name: start_date
          in: query
          description: Start date for analytics filter (YYYY-MM-DD format)
          required: false
          schema:
            type: string
            example: '2025-09-25'
        - name: end_date
          in: query
          description: End date for analytics filter (YYYY-MM-DD format)
          required: false
          schema:
            type: string
            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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: An unexpected error occurred. Please try again later.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.