> ## 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 the deliverability health trend and forecast for a number

> Per-DID predictive deliverability trajectory: a per-period score series, trend direction and slope, a linear forecast at a configurable horizon, and a step-change anomaly flag (read-only, live bucketed scan over locally-stored message rows). Periods below the sample-size floor return `score: null`, `tier: "unknown"` and are excluded from the trend fit. Distinct from /api/v1/numbers/{id}/health, which serves the daily point-in-time snapshot.



## OpenAPI

````yaml /openapi.yaml get /api/v1/numbers/{id}/health/trend
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/numbers/{id}/health/trend:
    get:
      tags:
        - Numbers
      summary: Get the deliverability health trend and forecast for a number
      description: >-
        Per-DID predictive deliverability trajectory: a per-period score series,
        trend direction and slope, a linear forecast at a configurable horizon,
        and a step-change anomaly flag (read-only, live bucketed scan over
        locally-stored message rows). Periods below the sample-size floor return
        `score: null`, `tier: "unknown"` and are excluded from the trend fit.
        Distinct from /api/v1/numbers/{id}/health, which serves the daily
        point-in-time snapshot.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
        - schema:
            type: string
            enum:
              - 30d
              - 60d
              - 90d
            default: 90d
          in: query
          name: window
          description: Lookback window
        - schema:
            type: string
            enum:
              - day
              - week
            default: week
          in: query
          name: bucket
          description: Period granularity of the score series
        - schema:
            type: integer
            minimum: 1
            maximum: 60
            default: 14
          in: query
          name: horizon_days
          description: Forecast horizon in days
      responses:
        '200':
          description: Trend series, direction, forecast and anomaly for the number
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      phone_number_id:
                        type: string
                      phone_number:
                        type: string
                      window:
                        type: string
                        enum:
                          - 30d
                          - 60d
                          - 90d
                      bucket:
                        type: string
                        enum:
                          - day
                          - week
                      window_start:
                        type: string
                        format: date-time
                      window_end:
                        type: string
                        format: date-time
                      lookback_days:
                        type: integer
                      min_sample_size:
                        type: integer
                      points:
                        type: array
                        items:
                          type: object
                          properties:
                            period_start:
                              type: string
                              format: date-time
                            period_end:
                              type: string
                              format: date-time
                            score:
                              type: number
                              nullable: true
                            tier:
                              type: string
                              description: >-
                                excellent | good | fair | poor | critical |
                                unknown
                            sample_size:
                              type: integer
                      scored_periods:
                        type: integer
                      direction:
                        type: string
                        description: improving | declining | stable | insufficient_data
                      slope_per_day:
                        type: number
                        nullable: true
                      forecast:
                        type: object
                        nullable: true
                        properties:
                          horizon_days:
                            type: integer
                          projected_score:
                            type: number
                          projected_tier:
                            type: string
                          slope_per_day:
                            type: number
                      anomaly:
                        type: object
                        properties:
                          detected:
                            type: boolean
                          latest_score:
                            type: number
                            nullable: true
                          baseline_mean:
                            type: number
                            nullable: true
                          deviation:
                            type: number
                            nullable: true
                  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_*)

````