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

# Get pipeline analytics

> Returns detailed analytics for a pipeline within a date range, optionally grouped.



## OpenAPI

````yaml /api-reference/voxys_crm_swagger.json get /api/v1/accounts/{account_id}/funnels/{id}/analytics
openapi: 3.1.0
info:
  title: Voxys Connect - CRM APIs
  description: >-
    CRM API documentation for Voxys Connect, covering Leads, Companies,
    Pipelines, Follow-up Tasks, and Conversation CRM.
  version: 1.0.0
  contact:
    email: support@voxys.ai
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://connect.voxys.ai
security:
  - userApiKey: []
tags:
  - name: Leads
    description: >-
      Manage CRM leads including creation, status changes, notes, and
      conversion.
  - name: Companies
    description: Manage companies, their contacts, timelines, and duplicate merging.
  - name: Pipelines
    description: Manage sales funnels (pipelines), their stages, and kanban cards.
  - name: Follow-up Tasks
    description: >-
      Create and manage follow-up tasks attached to leads, deals, or
      conversations.
  - name: Conversation CRM
    description: >-
      CRM panel within a conversation: link pipelines, leads, and convert to
      deal.
paths:
  /api/v1/accounts/{account_id}/funnels/{id}/analytics:
    parameters:
      - $ref: '#/components/parameters/account_id'
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: The ID of the pipeline.
    get:
      tags:
        - Pipelines
      summary: Get pipeline analytics
      description: >-
        Returns detailed analytics for a pipeline within a date range,
        optionally grouped.
      operationId: get-funnel-analytics
      parameters:
        - name: since
          in: query
          schema:
            type: string
            format: date
          description: Start date (inclusive) for analytics window.
          example: '2026-01-01'
        - name: until
          in: query
          schema:
            type: string
            format: date
          description: End date (inclusive) for analytics window.
          example: '2026-05-31'
        - name: agent_id
          in: query
          schema:
            type: integer
          description: Filter analytics to a specific agent.
        - name: group_by
          in: query
          schema:
            type: string
            enum:
              - day
              - week
              - month
              - agent
              - stage
          description: Grouping dimension for time-series or breakdown data.
      responses:
        '200':
          description: Pipeline analytics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/funnel_analytics'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: Pipeline not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
components:
  parameters:
    account_id:
      name: account_id
      in: path
      required: true
      schema:
        type: integer
      description: The numeric ID of the account.
  schemas:
    funnel_analytics:
      type: object
      properties:
        period:
          type: object
          properties:
            since:
              type: string
              format: date
            until:
              type: string
              format: date
        total_created:
          type: integer
          example: 30
        total_won:
          type: integer
          example: 10
        total_lost:
          type: integer
          example: 4
        total_value_created:
          type: number
          format: float
          example: 150000
        total_value_won:
          type: number
          format: float
          example: 60000
        average_deal_size:
          type: number
          format: float
          example: 6000
        conversion_rate:
          type: number
          format: float
          example: 33.3
        by_agent:
          type: array
          items:
            type: object
            properties:
              agent:
                $ref: '#/components/schemas/agent_summary'
              created:
                type: integer
              won:
                type: integer
              value_won:
                type: number
                format: float
        by_stage:
          type: array
          items:
            type: object
            properties:
              stage_id:
                type: integer
              stage_name:
                type: string
              count:
                type: integer
              value:
                type: number
                format: float
    error_response:
      type: object
      properties:
        error:
          type: string
          example: Unauthorized
    agent_summary:
      type: object
      properties:
        id:
          type: integer
          example: 1
        name:
          type: string
          example: Jane Smith
        email:
          type: string
          format: email
          example: jane@example.com
        avatar_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        API access token for authentication. Obtain from your Voxys Connect
        profile settings.

````