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

# Dialer local-presence caller-ID coverage + analytics

> Per-NPA local-presence caller-ID coverage report for one campaign. Surfaces which destination NPAs the campaign's caller-ID pool can present, the rolling answer-rate per destination NPA over the analytics window, and the highest-volume under-covered NPAs to add a local DID for. Helps operators optimize call completion rates when using local-presence (NPA-matching) caller-ID selection.



## OpenAPI

````yaml /openapi.yaml get /api/v1/dialer/campaigns/{id}/caller-id-coverage
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
paths:
  /api/v1/dialer/campaigns/{id}/caller-id-coverage:
    get:
      summary: Dialer local-presence caller-ID coverage + analytics
      description: >-
        Per-NPA local-presence caller-ID coverage report for one campaign.
        Surfaces which destination NPAs the campaign's caller-ID pool can
        present, the rolling answer-rate per destination NPA over the analytics
        window, and the highest-volume under-covered NPAs to add a local DID
        for. Helps operators optimize call completion rates when using
        local-presence (NPA-matching) caller-ID selection.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      responses:
        '200':
          description: Campaign caller-ID coverage report with per-NPA analytics
          content:
            application/json:
              schema:
                type: object
                description: Campaign caller-ID coverage report with per-NPA analytics
                properties:
                  data:
                    type: object
                    properties:
                      campaign_id:
                        type: string
                        description: Campaign ID
                      campaign_name:
                        type: string
                        description: Campaign name
                      caller_id_e164:
                        type: string
                        description: >-
                          Default caller-ID in E.164 format (fallback when pool
                          has no DID for the lead's NPA)
                      analytics_window_days:
                        type: integer
                        description: >-
                          Number of days of historical call attempt data
                          included in answer_rate calculations
                      leads_scan_capped:
                        type: boolean
                        description: >-
                          True if the lead NPA distribution scan hit the cap
                          (lead_count reflects floor, not exact total)
                      attempts_scan_capped:
                        type: boolean
                        description: >-
                          True if the call attempt scan hit the cap (attempt
                          counts reflect floor, not exact total)
                      strategy:
                        type: string
                        description: >-
                          Caller-ID assignment strategy for this campaign (e.g.
                          'npa_match', 'single')
                      pool_size:
                        type: integer
                        description: Number of DIDs in the campaign's caller-ID pool
                      pool_npas:
                        type: array
                        items:
                          type: string
                        description: >-
                          Distinct NPAs the campaign can present (from default
                          caller-ID + pool DIDs)
                      covered_npa_count:
                        type: integer
                        description: >-
                          Number of distinct lead destination NPAs that have a
                          presentable caller-ID
                      uncovered_lead_npa_count:
                        type: integer
                        description: >-
                          Number of distinct lead destination NPAs with no
                          presentable caller-ID
                      by_npa:
                        type: array
                        items:
                          type: object
                          properties:
                            npa:
                              type:
                                - string
                                - 'null'
                              description: >-
                                3-digit destination NPA, or null for non-NANP
                                (international/malformed) destinations
                            lead_count:
                              type: integer
                              description: Number of leads dialing this NPA in the campaign
                            attempts:
                              type: integer
                              description: >-
                                Number of call attempts to this NPA in the
                                analytics window
                            connected:
                              type: integer
                              description: >-
                                Number of successfully connected calls to this
                                NPA in the analytics window
                            answer_rate:
                              type:
                                - number
                                - 'null'
                              description: >-
                                Connected / Attempts ratio for this NPA; null
                                when attempts = 0
                            covered:
                              type: boolean
                              description: >-
                                True if the campaign can present a caller-ID in
                                this NPA
                        description: >-
                          Per-NPA breakdown sorted by lead volume descending
                          (non-NANP bucket last)
                      recommendations:
                        type: array
                        items:
                          type: object
                          properties:
                            npa:
                              type: string
                              description: >-
                                3-digit NPA recommended for local-DID expansion
                                (under-covered, high lead volume)
                            lead_count:
                              type: integer
                              description: Leads dialing this NPA
                            attempts:
                              type: integer
                              description: >-
                                Call attempts to this NPA in the analytics
                                window
                            connected:
                              type: integer
                              description: >-
                                Successfully connected calls to this NPA in the
                                analytics window
                            answer_rate:
                              type:
                                - number
                                - 'null'
                              description: >-
                                Connected / Attempts ratio; null when attempts =
                                0
                        description: >-
                          Top under-covered NPAs ranked by lead volume, up to 25
                          recommendations
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: >-
                          Unique request identifier (also returned in
                          X-Request-Id header)
                      timestamp:
                        type: string
                        format: date-time
                        description: ISO 8601 UTC timestamp of the response
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - NOT_FOUND
                      message:
                        type: string
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_*)

````