> ## 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 Number Analytics

> Retrieves analytics broken down by phone numbers.

Break analytics down by phone number. Use this to compare caller ID performance, monitor BYOT numbers, and identify numbers with poor pickup or completion rates.

## Useful filters

* `start_date` and `end_date` for reporting windows.
* `agent_id` to compare numbers used by one assistant.
* `bulk_list_id` to compare numbers inside one campaign.

## How to act on results

If one number underperforms, check number assignment, telephony provider health, calling hours, and recipient region fit.


## OpenAPI

````yaml get /analytics/number-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/number-analytics:
    get:
      tags:
        - analytics
      summary: Get Number Analytics
      description: Retrieves analytics broken down by phone numbers.
      operationId: getNumberAnalytics
      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: Number analytics retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  number_analytics:
                    type: array
                    description: Analytics data grouped by phone numbers
        '401':
          description: Unauthorized - Invalid or missing authentication.
        '500':
          description: Internal Server Error.

````