> ## 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 ranked automation opportunities > Mines the cross-channel conversation corpus into ranked 'what to automate next' contact reasons, each with measured volume/trend, an incremental automatable volume, a projected monthly deflection count and savings (priced via the automation-opportunities config), and a scaffold suggestion (AI agent, flow, or help article) to build the automation. Read-only, tenant-scoped, defaults to a trailing 30-day window. ## OpenAPI ````yaml /openapi.yaml get /api/v1/insights/automation-opportunities 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/automation-opportunities: get: summary: Get ranked automation opportunities description: >- Mines the cross-channel conversation corpus into ranked 'what to automate next' contact reasons, each with measured volume/trend, an incremental automatable volume, a projected monthly deflection count and savings (priced via the automation-opportunities config), and a scaffold suggestion (AI agent, flow, or help article) to build the automation. 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: limit description: >- Max opportunities returned (1-50, default 50), ranked biggest-win first. schema: type: integer responses: '200': description: >- Ranked automation opportunities (volume, trend, projected deflections/savings, scaffold suggestion) plus the ROI-assumption config and window totals. content: application/json: schema: type: object additionalProperties: true example: data: from: '2026-07-08T00:00:00.000Z' to: '2026-08-07T00:00:00.000Z' window_days: 30 currency: USD config: agent_cost_per_hour_cents: 3000 automation_cost_per_contact_cents: 5 target_deflection_rate: 0.6 default_aht_seconds: 300 min_volume: 5 totals: opportunity_count: 8 shown_count: 8 truncated: false total_automatable_volume: 410 total_projected_monthly_deflections: 390 total_projected_monthly_savings_cents: 975000 opportunities: - topic: password_reset volume: 180 previous_volume: 150 trend: rising change_pct: 20 channels: voice: 40 sms: 10 whatsapp: 0 email: 0 web_chat: 130 primary_channel: web_chat current_deflection_rate: 0.1 avg_aht_seconds: 240 target_deflection_rate: 0.6 automatable_volume: 90 projected_monthly_deflections: 90 handle_cost_per_contact_cents: 200 automation_cost_per_contact_cents: 5 net_savings_per_deflection_cents: 195 projected_monthly_savings_cents: 17550 opportunity_score: 100 scaffold: kind: flow title: >- Automate 'password reset' with a self-serve automation flow description: >- Deflect 'password reset' contacts (web_chat is the busiest channel) by scaffolding a self-serve automation flow. primary_channel: web_chat source_topic: password_reset 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_*) ````