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

# Conversation sentiment roll-up analytics

> Portfolio-level conversation-sentiment roll-up over a rolling window: an overall net-sentiment index plus trend buckets and breakdowns by channel, assigned agent, detected language and resolution state — so a CX team can monitor experience across all threads at once rather than one at a time and catch a 'great in English, failing in another locale' gap. Optionally narrow every breakdown with a single channel or language filter.



## OpenAPI

````yaml /openapi.yaml get /api/v1/analytics/sentiment
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/analytics/sentiment:
    get:
      tags:
        - Analytics
      summary: Conversation sentiment roll-up analytics
      description: >-
        Portfolio-level conversation-sentiment roll-up over a rolling window: an
        overall net-sentiment index plus trend buckets and breakdowns by
        channel, assigned agent, detected language and resolution state — so a
        CX team can monitor experience across all threads at once rather than
        one at a time and catch a 'great in English, failing in another locale'
        gap. Optionally narrow every breakdown with a single channel or language
        filter.
      parameters:
        - name: window
          in: query
          required: false
          schema:
            type: string
            enum:
              - 24h
              - 7d
              - 30d
              - 90d
            default: 7d
          description: Rolling lookback window.
        - name: channel
          in: query
          required: false
          schema:
            type: string
          description: Optional single-channel filter (e.g. chat, voice, email, whatsapp).
        - name: language
          in: query
          required: false
          schema:
            type: string
          description: >-
            Optional detected-conversation-language filter (ISO 639-1, e.g. en,
            es); 'unknown' selects messages with no detected language.
      responses:
        '200':
          description: Sentiment totals, trend and per-dimension breakdowns for the window.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      window:
                        type: string
                      channel:
                        type: string
                        nullable: true
                      language:
                        type: string
                        nullable: true
                      granularity:
                        type: string
                        enum:
                          - hour
                          - day
                      totals:
                        type: object
                        properties:
                          total:
                            type: integer
                          avg_score:
                            type: number
                            description: Mean sentiment_score, range [-1, 1].
                          positive:
                            type: integer
                          neutral:
                            type: integer
                          negative:
                            type: integer
                          net_sentiment:
                            type: number
                            description: >-
                              (positive − negative) / total, as a percentage in
                              [-100, 100].
                      trend:
                        type: array
                        items:
                          type: object
                          properties:
                            bucket:
                              type: string
                              format: date-time
                            avg_score:
                              type: number
                            net_sentiment:
                              type: number
                      by_channel:
                        type: array
                        items:
                          type: object
                      by_agent:
                        type: array
                        items:
                          type: object
                      by_language:
                        type: array
                        items:
                          type: object
                      by_resolution:
                        type: array
                        items:
                          type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  window: 7d
                  channel: null
                  language: null
                  granularity: day
                  totals:
                    total: 3120
                    avg_score: 0.21
                    positive: 1840
                    neutral: 900
                    negative: 380
                    net_sentiment: 46.8
                  trend:
                    - bucket: '2026-08-01T00:00:00.000Z'
                      avg_score: 0.24
                      net_sentiment: 49.1
                  by_channel:
                    - channel: chat
                      total: 1900
                      avg_score: 0.28
                      net_sentiment: 52
                  by_agent: []
                  by_language:
                    - language: en
                      total: 2600
                      net_sentiment: 48.2
                  by_resolution:
                    - resolution: resolved
                      net_sentiment: 61.4
                meta:
                  request_id: req_9f2c1a7b
                  timestamp: '2026-08-02T12:00:00.000Z'
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````