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

# Get Analytics Overview

> Returns aggregated analytics metrics with growth rates compared to the previous period

Returns aggregated analytics metrics with growth rates compared to the previous period. Use this endpoint to get a high-level summary of call performance including total calls, connected calls, conversations, meetings set, and follow-up tasks.

### Query Parameters

* **start\_date** (*optional*, date): Start date for the analytics period. Accepts ISO 8601 format. If omitted, defaults to 7 days before `end_date`.
  * Examples:
    * `2024-01-01T00:00:00.000Z` - ISO 8601 with UTC timezone
    * `2024-01-01` - Simple date format (YYYY-MM-DD)
    * `2024-01-01T00:00:00-05:00` - ISO 8601 with timezone offset
* **end\_date** (*optional*, date): End date for the analytics period. Accepts ISO 8601 format. If omitted, defaults to the current date.
  * Examples:
    * `2024-01-31T23:59:59.999Z` - ISO 8601 with UTC timezone
    * `2024-01-31` - Simple date format (YYYY-MM-DD)
    * `2024-01-31T23:59:59-05:00` - ISO 8601 with timezone offset
* **user\_ids** (*optional*, array of strings): Filter by specific user IDs.
  * Example: `["64d2b3f2c4e3a6b8f2d9e1a7"]`
* **disposition\_ids** (*optional*, array of numbers): Filter by disposition IDs (1=Meeting Set, 2=No Longer With Company, 3=Not Interested, etc.).
  * Example: `[1, 2, 3]`
* **timezone** (*optional*, string): Timezone for date calculations.
  * Example: `America/New_York`

### Response

Each metric is returned as an object of the form `{ "value": number, "growth_rate": number }`, where `growth_rate` is the percentage change compared to the previous period of equal length.

**Metrics included:**

* `total_calls` - Total number of calls made
* `total_inbound_calls` - Total number of inbound calls
* `connected_calls` - Calls that connected (answered by human, disposition \< 10)
* `conversations` - Connected calls with a meeting set or duration >= 60s
* `connection_rate` - `connected_calls / total_calls` (percentage)
* `conversation_rate` - `conversations / connected_calls` (percentage)
* `avg_calls_per_day` - Average calls per active day
* `total_call_duration` - Total call duration in seconds
* `total_meetings_set` - Calls with disposition ID = 1 (Meeting Set)
* `total_follow_up_tasks` - Number of follow-up tasks created
* `unique_contacts` - Number of distinct contacts called
* `unique_companies` - Number of distinct companies called

Example:

```json theme={null}
{
  "total_calls": { "value": 1240, "growth_rate": 12.5 },
  "total_inbound_calls": { "value": 85, "growth_rate": -3.1 },
  "connected_calls": { "value": 430, "growth_rate": 8.0 },
  "conversations": { "value": 96, "growth_rate": 5.2 },
  "connection_rate": { "value": 34.7, "growth_rate": 1.4 },
  "conversation_rate": { "value": 22.3, "growth_rate": -0.8 },
  "avg_calls_per_day": { "value": 62, "growth_rate": 4.0 },
  "total_call_duration": { "value": 51840, "growth_rate": 9.7 },
  "total_meetings_set": { "value": 41, "growth_rate": 10.0 },
  "total_follow_up_tasks": { "value": 58, "growth_rate": 6.3 },
  "unique_contacts": { "value": 512, "growth_rate": 7.1 },
  "unique_companies": { "value": 233, "growth_rate": 3.9 }
}
```


## OpenAPI

````yaml GET /v1/analytics/overview
openapi: 3.0.1
info:
  title: Salesfinity API
  description: API documentation for Salesfinity platform
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://client-api.salesfinity.co
security:
  - ApiKeyAuth: []
paths:
  /v1/analytics/overview:
    get:
      tags:
        - Analytics
      description: >-
        Returns aggregated analytics metrics with growth rates compared to the
        previous period
      operationId: get-analytics-overview
      parameters:
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Start date for the analytics period (ISO 8601). Examples:
            2024-01-01, 2024-01-01T00:00:00.000Z, 2024-01-01T00:00:00-05:00. If
            omitted, defaults to 7 days before end_date.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            End date for the analytics period (ISO 8601). Examples: 2024-01-31,
            2024-01-31T23:59:59.999Z, 2024-01-31T23:59:59-05:00. If omitted,
            defaults to the current date.
        - name: user_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          description: Filter by specific user IDs
        - name: disposition_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
          description: Filter by disposition IDs (1-14)
        - name: timezone
          in: query
          required: false
          schema:
            type: string
          description: IANA timezone for date calculations (e.g., America/New_York)
      responses:
        '200':
          description: Analytics overview retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsOverviewResponse'
components:
  schemas:
    AnalyticsOverviewResponse:
      type: object
      properties:
        total_calls:
          $ref: '#/components/schemas/MetricWithGrowth'
        total_inbound_calls:
          $ref: '#/components/schemas/MetricWithGrowth'
        connected_calls:
          $ref: '#/components/schemas/MetricWithGrowth'
        conversations:
          $ref: '#/components/schemas/MetricWithGrowth'
        connection_rate:
          $ref: '#/components/schemas/MetricWithGrowth'
        conversation_rate:
          $ref: '#/components/schemas/MetricWithGrowth'
        avg_calls_per_day:
          $ref: '#/components/schemas/MetricWithGrowth'
        total_call_duration:
          $ref: '#/components/schemas/MetricWithGrowth'
        total_meetings_set:
          $ref: '#/components/schemas/MetricWithGrowth'
        total_follow_up_tasks:
          $ref: '#/components/schemas/MetricWithGrowth'
        unique_contacts:
          $ref: '#/components/schemas/MetricWithGrowth'
        unique_companies:
          $ref: '#/components/schemas/MetricWithGrowth'
      required:
        - total_calls
        - total_inbound_calls
        - connected_calls
        - conversations
        - connection_rate
        - conversation_rate
        - avg_calls_per_day
        - total_call_duration
        - total_meetings_set
        - total_follow_up_tasks
        - unique_contacts
        - unique_companies
    MetricWithGrowth:
      type: object
      properties:
        value:
          type: number
        growth_rate:
          type: number
          description: Percentage change compared to the previous period of equal length
      required:
        - value
        - growth_rate
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````