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

# Get knowledge-base staleness report

> Freshness scorecard for a knowledge base: classifies every non-chunk document as `fresh`, `stale`, or `critical` against its review-cadence window and returns the bucket totals plus an oldest-first `attention_required` queue, so you can spot the articles most likely to ground a wrong agent answer. A document's age is measured from its last operator-verified time (falling back to its last update); the default window is 90 days, overridable per request. Read-only; requires the `knowledge:read` scope.



## OpenAPI

````yaml /openapi.yaml get /api/v1/knowledge-bases/{id}/staleness
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/knowledge-bases/{id}/staleness:
    get:
      tags:
        - Knowledge Bases
      summary: Get knowledge-base staleness report
      description: >-
        Freshness scorecard for a knowledge base: classifies every non-chunk
        document as `fresh`, `stale`, or `critical` against its review-cadence
        window and returns the bucket totals plus an oldest-first
        `attention_required` queue, so you can spot the articles most likely to
        ground a wrong agent answer. A document's age is measured from its last
        operator-verified time (falling back to its last update); the default
        window is 90 days, overridable per request. Read-only; requires the
        `knowledge:read` scope.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Knowledge base ID (`kb_…`).
        - schema:
            type: integer
            minimum: 1
            maximum: 3650
          in: query
          name: default_threshold_days
          required: false
          description: >-
            Org-wide review-cadence window in days applied to documents without
            a per-document override. Defaults to 90.
      responses:
        '200':
          description: >-
            The staleness scorecard — bucket totals plus the oldest-first
            attention queue.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      knowledge_base_id:
                        type: string
                      totals:
                        type: object
                        properties:
                          fresh:
                            type: integer
                          stale:
                            type: integer
                          critical:
                            type: integer
                          documents_scanned:
                            type: integer
                          never_verified:
                            type: integer
                            description: Documents that have never been operator-verified.
                      attention_required:
                        type: array
                        description: >-
                          Non-fresh documents, oldest-first (never-verified
                          documents first).
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            type:
                              type: string
                            status:
                              type: string
                            bucket:
                              type: string
                              enum:
                                - fresh
                                - stale
                                - critical
                            age_days:
                              type: integer
                              description: Days since the document's freshness anchor.
                            threshold_days:
                              type: integer
                            last_verified_at:
                              type:
                                - 'null'
                                - string
                              format: date-time
                            last_cited_at:
                              type:
                                - 'null'
                                - string
                              format: date-time
                            updated_at:
                              type:
                                - 'null'
                                - string
                              format: date-time
                      default_threshold_days:
                        type: integer
                      scanned_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: No knowledge base with the given ID exists for the caller's tenant.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      status:
                        type: integer
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_*)

````