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

# Team metrics

> Returns team-wide KPIs with period-over-period comparison and a per-user breakdown. Covers all calls (inbound + outbound).

<Note>
  **Required scope:** `CONVERSATIONS_READ`
</Note>


## OpenAPI

````yaml POST /v2/api/analytics/overview
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
paths:
  /v2/api/analytics/overview:
    post:
      tags:
        - Analytics
      summary: Team metrics
      description: >-
        Returns team-wide KPIs with period-over-period comparison and a per-user
        breakdown. Covers all calls (inbound + outbound).
      operationId: getTeamMetrics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyticsBaseRequest'
            example:
              date:
                from: '2026-03-25'
                to: '2026-04-21'
              compare_date:
                from: '2026-02-25'
                to: '2026-03-24'
              user_ids:
                - usr-abc123
                - usr-def456
      responses:
        '200':
          description: Team summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      date:
                        $ref: '#/components/schemas/AnalyticsDateRange'
                      compare_date:
                        $ref: '#/components/schemas/AnalyticsDateRange'
                      summary:
                        type: object
                        properties:
                          total_calls:
                            $ref: '#/components/schemas/MetricValue'
                          talk_time_seconds:
                            $ref: '#/components/schemas/MetricValue'
                          calls_over_1_min:
                            $ref: '#/components/schemas/MetricValue'
                          answer_rate:
                            $ref: '#/components/schemas/MetricValue'
                      breakdown:
                        type: array
                        items:
                          $ref: '#/components/schemas/UserBreakdown'
                      last_updated:
                        type: string
                        format: date-time
                        description: When the metrics were last updated
              example:
                data:
                  date:
                    from: '2026-03-25'
                    to: '2026-04-21'
                  compare_date:
                    from: '2026-02-25'
                    to: '2026-03-24'
                  summary:
                    total_calls:
                      value: 2899
                      previous: 2512
                      change: 0.15
                    talk_time_seconds:
                      value: 81720
                      previous: 103380
                      change: -0.21
                    calls_over_1_min:
                      value: 290
                      previous: 310
                      change: -0.06
                    answer_rate:
                      value: 0.503
                      previous: 0.46
                      change: 0.09
                  breakdown:
                    - user:
                        id: usr-abc123
                        name: Adrien Gaucher
                        email: adrien@company.com
                      calls:
                        value: 673
                        change: -0.05
                      talk_time_seconds:
                        value: 38460
                        change: -0.11
                      calls_over_1_min:
                        value: 141
                        change: -0.1
                      answer_rate:
                        value: 0.645
                        change: -0.03
                  last_updated: '2026-04-21T19:07:00Z'
        '400':
          $ref: '#/components/responses/ApiValidationError'
        '401':
          $ref: '#/components/responses/ApiUnauthorized'
        '429':
          $ref: '#/components/responses/ApiRateLimited'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    AnalyticsBaseRequest:
      type: object
      required:
        - date
      properties:
        date:
          $ref: '#/components/schemas/AnalyticsDateRange'
        compare_date:
          $ref: '#/components/schemas/AnalyticsDateRange'
          description: Comparison period. Metrics will include change vs this period.
        user_ids:
          type: array
          items:
            type: string
          description: Filter by user IDs. Cannot be combined with allo_numbers.
        allo_numbers:
          type: array
          items:
            type: string
          description: Filter by Allo numbers (E.164). Cannot be combined with user_ids.
    AnalyticsDateRange:
      type: object
      required:
        - from
        - to
      properties:
        from:
          type: string
          format: date
          description: Start date
          example: '2026-03-25'
        to:
          type: string
          format: date
          description: End date
          example: '2026-04-21'
    MetricValue:
      type: object
      properties:
        value:
          type: number
          description: Current period value
        previous:
          type: number
          nullable: true
          description: Previous period value
        change:
          type: number
          nullable: true
          description: Percentage change vs previous period (e.g. 0.15 = +15%)
    UserBreakdown:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/UserRef'
        calls:
          $ref: '#/components/schemas/MetricValue'
        talk_time_seconds:
          $ref: '#/components/schemas/MetricValue'
        calls_over_1_min:
          $ref: '#/components/schemas/MetricValue'
        answer_rate:
          $ref: '#/components/schemas/MetricValue'
    UserRef:
      type: object
      properties:
        id:
          type: string
          example: usr-abc123
        name:
          type: string
          example: John
        email:
          type: string
          example: john@acme.com
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  responses:
    ApiValidationError:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````