> ## 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 flow conversion analytics

> Per-flow conversion funnel: how many contacts entered and completed the flow, a per-node drop-off funnel in flow-graph traversal order, and goal attribution (event or trait) within the configured window after a contact exits. The conversion goal defaults to the flow's stored definition.conversionGoal and can be overridden per-request. Read-only aggregation over the executions log.



## OpenAPI

````yaml /openapi.yaml get /api/v1/flows/{id}/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/flows/{id}/analytics:
    get:
      tags:
        - Flows
      summary: Get flow conversion analytics
      description: >-
        Per-flow conversion funnel: how many contacts entered and completed the
        flow, a per-node drop-off funnel in flow-graph traversal order, and goal
        attribution (event or trait) within the configured window after a
        contact exits. The conversion goal defaults to the flow's stored
        definition.conversionGoal and can be overridden per-request. Read-only
        aggregation over the executions log.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
        - schema:
            type: string
            format: date-time
          in: query
          name: since
          required: false
          description: >-
            Lower bound (inclusive) of the entry window — executions started at
            or after this ISO-8601 timestamp.
        - schema:
            type: string
            format: date-time
          in: query
          name: until
          required: false
          description: >-
            Upper bound of the entry window — executions started before this
            ISO-8601 timestamp.
        - schema:
            type: integer
            minimum: 1
            maximum: 365
          in: query
          name: window_days
          required: false
          description: >-
            Goal attribution window in days after a contact exits the flow,
            clamped to [1, 365].
        - schema:
            type: string
            maxLength: 200
          in: query
          name: goal_event
          required: false
          description: >-
            Override the flow's stored goal — count this event as the
            conversion.
        - schema:
            type: string
            maxLength: 200
          in: query
          name: goal_trait
          required: false
          description: >-
            Override the flow's stored goal — count an identify setting this
            trait as the conversion.
        - schema:
            type: string
            maxLength: 500
          in: query
          name: goal_value
          required: false
          description: >-
            When goal_trait is set, only count the conversion when the trait is
            set to this value.
      responses:
        '200':
          description: Per-flow conversion funnel and goal attribution.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      flow_id:
                        type: string
                      since:
                        type: string
                        format: date-time
                      until:
                        type: string
                        format: date-time
                      window_days:
                        type: integer
                      goal:
                        type: object
                        nullable: true
                        properties:
                          type:
                            type: string
                            enum:
                              - event
                              - trait
                          event:
                            type: string
                          trait:
                            type: string
                          value:
                            type: string
                          windowDays:
                            type: integer
                      entered:
                        type: integer
                        description: Contacts that entered the flow within the window.
                      completed:
                        type: integer
                        description: Contacts that reached a completed status.
                      converted:
                        type: integer
                        description: >-
                          Contacts that met the conversion goal within the
                          attribution window.
                      completion_rate:
                        type: number
                        nullable: true
                        description: completed / entered (null when entered is 0).
                      conversion_rate:
                        type: number
                        nullable: true
                        description: converted / entered (null when entered is 0).
                      funnel:
                        type: array
                        description: Per-node drop-off in flow-graph traversal order.
                        items:
                          type: object
                          properties:
                            node_id:
                              type: string
                            node_type:
                              type: string
                              nullable: true
                            label:
                              type: string
                              nullable: true
                            reached:
                              type: integer
                            dropped_off:
                              type: integer
                            step_conversion_rate:
                              type: number
                              nullable: true
                              description: >-
                                Conversion from the immediately previous step
                                (null for the entry step).
                            overall_conversion_rate:
                              type: number
                              nullable: true
                              description: Conversion from the funnel entry (first node).
        '404':
          description: Flow not found.
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_*)

````