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

# Sentiment summary

> Returns aggregate sentiment summary counts and percentages.



## OpenAPI

````yaml /api-reference/voxys_analytics_swagger.json get /api/v1/accounts/{account_id}/customer_pulse/summary
openapi: 3.1.0
info:
  title: Voxys Connect – Extended Features
  description: >-
    API documentation for Voxys Connect extended features: Campaigns, WhatsApp
    Templates & Flows, Appointments, Scheduled Messages, Projects, Internal
    Channels, Customer Pulse, and Reports.
  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: Customer Pulse
    description: Sentiment analysis and customer pulse metrics
  - name: Leads Reports
    description: Lead pipeline analytics and CSV export (v2)
paths:
  /api/v1/accounts/{account_id}/customer_pulse/summary:
    get:
      tags:
        - Customer Pulse
      summary: Sentiment summary
      description: Returns aggregate sentiment summary counts and percentages.
      operationId: getCustomerPulseSummary
      responses:
        '200':
          description: Sentiment summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_pulse_summary'
        '401':
          $ref: '#/components/responses/unauthorized'
components:
  schemas:
    customer_pulse_summary:
      type: object
      properties:
        total_analyzed:
          type: integer
        positive_count:
          type: integer
        neutral_count:
          type: integer
        negative_count:
          type: integer
        positive_percentage:
          type: number
          format: float
        neutral_percentage:
          type: number
          format: float
        negative_percentage:
          type: number
          format: float
        average_score:
          type: number
          format: float
  responses:
    unauthorized:
      description: Authentication failed – invalid or missing api_access_token
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        All API requests must include the `api_access_token` header with a valid
        agent or administrator token.

````