> ## 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 per-DID branded-calling (Rich Call Data) answer-rate uplift

> Per-DID branded-calling / Rich Call Data (RCD) answer-rate uplift readout. Compares this number's OUTBOUND answer rate over the requested `window` against the immediately-preceding equal-length baseline window, and surfaces the org's branded-calling registration status alongside, so a customer who registered a brand profile can see the contact-center answer-rate lift branded calling produces (Twilio / First-Orion parity). Pure read on `call_logs` plus the org's branded-calling setting — no carrier round-trip. Org-ownership gated: a sibling subaccount sharing the tenant schema gets 404 on another subaccount's DID id (enumeration-safe). Answer rates are 0..1 fractions and are `null` when no outbound calls were placed in the cohort; uplift values are `null` when a comparable baseline rate is undefined (no misleading 0% lift).



## OpenAPI

````yaml /openapi.yaml get /api/v1/numbers/{id}/branded-calling-analytics
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/numbers/{id}/branded-calling-analytics:
    get:
      tags:
        - Numbers
      summary: Get per-DID branded-calling (Rich Call Data) answer-rate uplift
      description: >-
        Per-DID branded-calling / Rich Call Data (RCD) answer-rate uplift
        readout. Compares this number's OUTBOUND answer rate over the requested
        `window` against the immediately-preceding equal-length baseline window,
        and surfaces the org's branded-calling registration status alongside, so
        a customer who registered a brand profile can see the contact-center
        answer-rate lift branded calling produces (Twilio / First-Orion parity).
        Pure read on `call_logs` plus the org's branded-calling setting — no
        carrier round-trip. Org-ownership gated: a sibling subaccount sharing
        the tenant schema gets 404 on another subaccount's DID id
        (enumeration-safe). Answer rates are 0..1 fractions and are `null` when
        no outbound calls were placed in the cohort; uplift values are `null`
        when a comparable baseline rate is undefined (no misleading 0% lift).
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
        - schema:
            type: string
            enum:
              - 24h
              - 7d
              - 30d
              - 90d
            default: 30d
          in: query
          name: window
          required: false
          description: >-
            Comparison window length. The baseline is the equal-length window
            immediately preceding it, so the effective scan is 2× the token
            span. Defaults to 30d.
      responses:
        '200':
          description: >-
            Branded-calling answer-rate uplift for the number, wrapped in the
            standard `{ data, meta }` envelope.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      phone_number_id:
                        type: string
                      phone_number:
                        type: string
                        description: E.164 number the analytics are keyed to.
                      window:
                        type: string
                        enum:
                          - 24h
                          - 7d
                          - 30d
                          - 90d
                      current_window:
                        type: object
                        description: ISO-8601 [start, end) bounds of the requested window.
                        properties:
                          start:
                            type: string
                            format: date-time
                          end:
                            type: string
                            format: date-time
                      baseline_window:
                        type: object
                        description: >-
                          ISO-8601 [start, end) bounds of the equal-length
                          baseline window immediately preceding the current one.
                        properties:
                          start:
                            type: string
                            format: date-time
                          end:
                            type: string
                            format: date-time
                      branded_calling:
                        type: object
                        description: Org-level Rich Call Data registration status.
                        properties:
                          enabled:
                            type: boolean
                            description: Whether the org has RCD signalling enabled.
                          display_name:
                            type: string
                            description: >-
                              Registered brand display name, or empty string
                              when unconfigured.
                          registered_with_carriers:
                            type: array
                            items:
                              type: string
                            description: Downstream carriers the brand is registered with.
                      outbound:
                        type: object
                        properties:
                          current:
                            type: object
                            description: Outbound cohort for the requested window.
                            properties:
                              total:
                                type: integer
                                description: >-
                                  Outbound calls originated from this DID in the
                                  window.
                              answered:
                                type: integer
                                description: >-
                                  Of those, the count that reached an answered
                                  terminal status (completed / answered).
                              answer_rate:
                                type: number
                                nullable: true
                                description: >-
                                  answered / total as a 0..1 fraction (4dp), or
                                  null when no outbound calls were placed.
                          baseline:
                            type: object
                            description: Outbound cohort for the preceding baseline window.
                            properties:
                              total:
                                type: integer
                              answered:
                                type: integer
                              answer_rate:
                                type: number
                                nullable: true
                                description: >-
                                  answered / total as a 0..1 fraction (4dp), or
                                  null when no outbound calls were placed.
                          uplift:
                            type: object
                            description: Period-over-period change current vs baseline.
                            properties:
                              absolute_points:
                                type: number
                                nullable: true
                                description: >-
                                  current − baseline answer rate, in 0..1
                                  rate-points (4dp). null when either window had
                                  no calls.
                              relative_pct:
                                type: number
                                nullable: true
                                description: >-
                                  ((current − baseline) / baseline) · 100, as a
                                  percentage (1dp). null when the baseline rate
                                  is null or zero.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
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_*)

````