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

# Compare AI agents on cost, revenue, and quality KPIs

> Ranks the named agents (2 or more, via `agentIds`) against each other and the org-wide average on containment, resolution, escalation, cost, attributed revenue, and margin, reusing the agent-roi and containment aggregates. Use it to build a side-by-side agent comparison table. Read-only, tenant-scoped, defaults to a trailing 30-day window.



## OpenAPI

````yaml /openapi.yaml get /api/v1/insights/agent-comparison
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/insights/agent-comparison:
    get:
      summary: Compare AI agents on cost, revenue, and quality KPIs
      description: >-
        Ranks the named agents (2 or more, via `agentIds`) against each other
        and the org-wide average on containment, resolution, escalation, cost,
        attributed revenue, and margin, reusing the agent-roi and containment
        aggregates. Use it to build a side-by-side agent comparison table.
        Read-only, tenant-scoped, defaults to a trailing 30-day window.
      parameters:
        - in: query
          name: from
          description: >-
            Window start, ISO-8601 with offset. Defaults to 30 days before `to`.
            Range is capped at 365 days.
          schema:
            type: string
            format: date-time
        - in: query
          name: to
          description: Window end, ISO-8601 with offset. Defaults to now.
          schema:
            type: string
            format: date-time
        - in: query
          name: agentIds
          description: >-
            Required. Comma-separated agent ids to compare (at least 2, at most
            200).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            The requested agents' flat KPI rows plus the metric catalogue and
            the org-wide average baseline.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                data:
                  from: '2026-07-08T00:00:00.000Z'
                  to: '2026-08-07T00:00:00.000Z'
                  currency: USD
                  timezone: America/New_York
                  metrics:
                    - key: containment_rate
                      label: Containment %
                      unit: percent
                      higherIsBetter: true
                  population_size: 6
                  ranked_population_size: 6
                  population_truncated: false
                  org_average:
                    containment_rate: 75.1
                    resolution_rate: 71
                    escalation_rate: 24.9
                    cost_cents: 30716
                    attributed_revenue_cents: 103333
                    margin_cents: 72617
                    margin_percent: 70.3
                  agents:
                    - agent_id: agt_01J8Z9K3P4Q5R6S7T8U9V0W1X2
                      agent_name: Billing Bot
                      model: gpt-4o
                      conversation_count: 210
                      cost_cents: 41200
                      attributed_revenue_cents: 180000
                      margin_cents: 138800
                      margin_percent: 77.1
                      containment_rate: 81.9
                      resolution_rate: 76.2
                      escalation_rate: 18.1
                meta:
                  request_id: req_01J8Z9K3P4Q5R6S7T8U9V0W1X2
                  timestamp: '2026-08-07T12: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_*)

````