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

# Org-wide quality-management summary

> Cross-channel quality-management rollup for supervisors and admins. Aggregates LLM-judged conversation outcomes across inbox and voice into one org-wide view, returning overall totals (conversations scored, pass rate, average judge confidence), a per-channel breakdown, the top rubrics by evaluation volume with their pass rates, and the most recent low-confidence failures for triage. Use it to power a Quality Management overview page instead of navigating agent-by-agent. Read-only; requires an owner, admin, or supervisor role.



## OpenAPI

````yaml /openapi.yaml get /api/v1/quality/summary
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/quality/summary:
    get:
      tags:
        - Quality
      summary: Org-wide quality-management summary
      description: >-
        Cross-channel quality-management rollup for supervisors and admins.
        Aggregates LLM-judged conversation outcomes across inbox and voice into
        one org-wide view, returning overall totals (conversations scored, pass
        rate, average judge confidence), a per-channel breakdown, the top
        rubrics by evaluation volume with their pass rates, and the most recent
        low-confidence failures for triage. Use it to power a Quality Management
        overview page instead of navigating agent-by-agent. Read-only; requires
        an owner, admin, or supervisor role.
      parameters:
        - schema:
            type: string
            maxLength: 16
          in: query
          name: days
          required: false
          description: >-
            Look-back window in days over each outcome's evaluation time (1-90).
            Defaults to 30, capped at 90; an out-of-range or non-numeric value
            falls back to 30.
        - schema:
            type: string
            maxLength: 16
          in: query
          name: conv_type
          required: false
          description: >-
            Restrict the rollup to a single conversation channel - `inbox`,
            `voice`, or `all` for both. Defaults to `all`; any unrecognised
            value falls back to `all`.
      responses:
        '200':
          description: Org-wide quality summary for the requested window.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      window:
                        type: object
                        additionalProperties: true
                        description: Echo of the resolved query window.
                        properties:
                          days:
                            type: integer
                            description: Look-back window applied, in days.
                          conv_type:
                            type: string
                            enum:
                              - inbox
                              - voice
                              - all
                            description: Conversation channel the rollup was scoped to.
                      totals:
                        type: object
                        additionalProperties: true
                        description: >-
                          Overall totals across every scored conversation in the
                          window.
                        properties:
                          total_scored:
                            type: integer
                            description: Distinct conversations LLM-judged in the window.
                          total_outcomes:
                            type: integer
                            description: >-
                              Total outcome rows evaluated; a conversation may
                              be scored against several rubrics.
                          pass_rate:
                            type:
                              - number
                              - 'null'
                            description: >-
                              Mean passed-rubric ratio (0-1), or null when
                              nothing was scored.
                          avg_confidence:
                            type:
                              - number
                              - 'null'
                            description: >-
                              Mean judge confidence (0-1), or null when nothing
                              was scored.
                      by_channel:
                        type: array
                        description: Per-channel breakdown (inbox vs voice).
                        items:
                          type: object
                          additionalProperties: true
                      by_rubric:
                        type: array
                        description: >-
                          Top 10 rubrics by evaluation volume, each with its
                          pass rate.
                        items:
                          type: object
                          additionalProperties: true
                      recent_failures:
                        type: array
                        description: >-
                          Up to 10 most recent failed low-confidence outcomes
                          for triage drill-down.
                        items:
                          type: object
                          additionalProperties: true
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  window:
                    days: 30
                    conv_type: all
                  totals:
                    total_scored: 1284
                    total_outcomes: 3960
                    pass_rate: 0.87
                    avg_confidence: 0.91
                  by_channel:
                    - conversation_type: inbox
                      total_scored: 920
                      pass_rate: 0.89
                      avg_confidence: 0.92
                    - conversation_type: voice
                      total_scored: 364
                      pass_rate: 0.82
                      avg_confidence: 0.88
                  by_rubric:
                    - rubric_id: rub_greeting
                      rubric_name: Greeting & identification
                      rubric_scope: conversation
                      total_evals: 1284
                      pass_rate: 0.94
                      avg_confidence: 0.93
                    - rubric_id: rub_resolution
                      rubric_name: Issue resolution
                      rubric_scope: conversation
                      total_evals: 1190
                      pass_rate: 0.81
                      avg_confidence: 0.9
                  recent_failures:
                    - conversation_id: conv_8f3a21
                      conversation_type: voice
                      rubric_id: rub_resolution
                      rubric_name: Issue resolution
                      confidence: 0.42
                      reasoning_excerpt: >-
                        Agent closed the ticket without confirming the refund
                        was processed.
                      evaluated_at: '2026-08-15T18:22:04.000Z'
                meta:
                  request_id: req_1a2b3c4d5e
                  timestamp: '2026-08-16T09:00:00.000Z'
        '401':
          description: >-
            `error.code` is `UNAUTHENTICATED` - a signed-in owner, admin, or
            supervisor is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: >-
            `error.code` is `INTERNAL_ERROR` - the quality summary could not be
            loaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      additionalProperties: false
      properties:
        error:
          type: object
          required:
            - code
            - message
            - status
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              nullable: true
              additionalProperties: true
        meta:
          type: object
          required:
            - request_id
            - timestamp
          additionalProperties: false
          properties:
            request_id:
              type: string
              description: Unique request identifier (also returned as X-Request-Id header)
            timestamp:
              type: string
              format: date-time
            docs_url:
              type: string
              format: uri
              nullable: true
  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_*)

````