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

# Create a scheduled analytics report

> Schedules a recurring analytics report emailed to one or more recipients on a daily, weekly or monthly cadence. Choose a report type (messaging_volume, deliverability, top_contacts, spend or custom), 1–50 unique recipient emails, optional filters (a custom report's filters.dataset selects the messages or queue_performance dataset), an enabled flag, and an IANA timezone the cadence anchors to. Requires an owner, admin or developer role; returns the created report with its computed next_send_at.



## OpenAPI

````yaml /openapi.yaml post /api/v1/analytics/scheduled-reports
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/analytics/scheduled-reports:
    post:
      tags:
        - Analytics
      summary: Create a scheduled analytics report
      description: >-
        Schedules a recurring analytics report emailed to one or more recipients
        on a daily, weekly or monthly cadence. Choose a report type
        (messaging_volume, deliverability, top_contacts, spend or custom), 1–50
        unique recipient emails, optional filters (a custom report's
        filters.dataset selects the messages or queue_performance dataset), an
        enabled flag, and an IANA timezone the cadence anchors to. Requires an
        owner, admin or developer role; returns the created report with its
        computed next_send_at.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - type
                - frequency
                - recipients
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                type:
                  type: string
                  enum:
                    - messaging_volume
                    - deliverability
                    - top_contacts
                    - spend
                    - custom
                frequency:
                  type: string
                  enum:
                    - daily
                    - weekly
                    - monthly
                recipients:
                  description: >-
                    1–50 unique recipient emails, as an array or a
                    comma-separated string.
                  oneOf:
                    - type: array
                      items:
                        type: string
                        format: email
                    - type: string
                filters:
                  type: object
                  nullable: true
                  description: >-
                    Optional saved-query definition; filters.dataset must name a
                    known dataset when present.
                enabled:
                  type: boolean
                  default: true
                timezone:
                  type: string
                  description: IANA zone name, e.g. America/New_York.
            example:
              name: Weekly deliverability
              type: deliverability
              frequency: weekly
              recipients:
                - ops@acme.com
              enabled: true
              timezone: America/New_York
      responses:
        '201':
          description: The created scheduled report.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organization_id:
                        type: string
                      name:
                        type: string
                      type:
                        type: string
                        enum:
                          - messaging_volume
                          - deliverability
                          - top_contacts
                          - spend
                          - custom
                      frequency:
                        type: string
                        enum:
                          - daily
                          - weekly
                          - monthly
                      recipients:
                        type: array
                        items:
                          type: string
                      filters:
                        type: object
                        nullable: true
                      enabled:
                        type: boolean
                      timezone:
                        type: string
                        nullable: true
                      last_sent_at:
                        type: string
                        format: date-time
                        nullable: true
                      next_send_at:
                        type: string
                        format: date-time
                      created_by:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  id: rpt_7c1f0a
                  organization_id: org_42
                  name: Weekly deliverability
                  type: deliverability
                  frequency: weekly
                  recipients:
                    - ops@acme.com
                  filters: null
                  enabled: true
                  timezone: America/New_York
                  last_sent_at: '2026-07-26T13:00:00.000Z'
                  next_send_at: '2026-08-02T13:00:00.000Z'
                  created_by: usr_9
                  created_at: '2026-06-01T10:00:00.000Z'
                  updated_at: '2026-07-26T13:00:00.000Z'
                meta:
                  request_id: req_9f2c1a7b
                  timestamp: '2026-08-02T12: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_*)

````