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

# List knowledge-base coverage gaps

> Surface the questions a knowledge base could not confidently answer over a look-back window, clustered into themes with a representative question, how many times it was asked, and how many distinct contacts hit it. Gaps are drawn from low-confidence answers and human escalations across every agent linked to the KB. Use it to decide which articles to write next; an unlinked KB returns an empty cluster list.



## OpenAPI

````yaml /openapi.yaml get /api/v1/agents/knowledge-bases/{id}/gaps
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/agents/knowledge-bases/{id}/gaps:
    get:
      tags:
        - Agents
      summary: List knowledge-base coverage gaps
      description: >-
        Surface the questions a knowledge base could not confidently answer over
        a look-back window, clustered into themes with a representative
        question, how many times it was asked, and how many distinct contacts
        hit it. Gaps are drawn from low-confidence answers and human escalations
        across every agent linked to the KB. Use it to decide which articles to
        write next; an unlinked KB returns an empty cluster list.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Identifier of the knowledge base to analyse.
        - schema:
            type: integer
            minimum: 1
            maximum: 180
            default: 30
          in: query
          name: days
          required: false
          description: Look-back window in days (1–180, default 30).
        - schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 10
          in: query
          name: limit
          required: false
          description: Maximum number of gap clusters to return (1–50, default 10).
        - schema:
            type: string
          in: query
          name: agent_id
          required: false
          description: Narrow the analysis to a single agent linked to the KB.
      responses:
        '200':
          description: Clustered knowledge-base coverage gaps for the window.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      kb_id:
                        type: string
                      days:
                        type: integer
                      agent_ids:
                        type: array
                        items:
                          type: string
                      total_low_confidence:
                        type: integer
                      total_escalations:
                        type: integer
                      clusters:
                        type: array
                        items:
                          type: object
                          properties:
                            cluster_id:
                              type: string
                            representative_question:
                              type: string
                            question_count:
                              type: integer
                            contact_count:
                              type: integer
                            recent_examples:
                              type: array
                              items:
                                type: object
                                properties:
                                  question:
                                    type: string
                                  conversation_id:
                                    type: string
                                  created_at:
                                    type: string
                                    format: date-time
                            evidence:
                              type: string
                              enum:
                                - low_confidence
                                - escalation
                                - mixed
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
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
  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_*)

````