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

# List conversion goals

> Returns the tenant's configured conversion goals (paginated by limit/offset), each with its type, attribution model, lookback window, monetary value and — for pixel_fire goals — a copy-paste pixel URL hint. Every row also carries its batched all-time conversion count and revenue so the Goals table renders those columns without an N+1. Use it to populate the analytics Goals management screen.



## OpenAPI

````yaml /openapi.yaml get /api/v1/analytics/goals/
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/goals/:
    get:
      tags:
        - Analytics
      summary: List conversion goals
      description: >-
        Returns the tenant's configured conversion goals (paginated by
        limit/offset), each with its type, attribution model, lookback window,
        monetary value and — for pixel_fire goals — a copy-paste pixel URL hint.
        Every row also carries its batched all-time conversion count and revenue
        so the Goals table renders those columns without an N+1. Use it to
        populate the analytics Goals management screen.
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          description: Maximum number of goals to return.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of goals to skip, for pagination.
      responses:
        '200':
          description: Paginated list of goals with batched conversion/revenue totals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/AnalyticsGoal'
                      total:
                        type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  items:
                    - id: goal_7Fb2c1a7b
                      name: Checkout completed
                      type: pixel_fire
                      config: {}
                      value_cents: 4999
                      lookback_days: 7
                      attribution_model: last_touch
                      enabled: true
                      created_at: '2026-07-01T09:12:00.000Z'
                      updated_at: '2026-07-20T14:03:00.000Z'
                      pixel_url: >-
                        https://api.orbit.devotel.io/g/goal_7Fb2c1a7b/{contact_id}.gif?sig=<hmac(goalId:contact_id:tenant_schema)>&schema=<tenant_schema>
                      total_conversions: 312
                      total_revenue_cents: 1559688
                  total: 1
                meta:
                  request_id: req_9f2c1a7b
                  timestamp: '2026-08-02T12:00:00.000Z'
components:
  schemas:
    AnalyticsGoal:
      type: object
      description: >-
        A conversion goal configured for the tenant, with its attribution
        settings and (for pixel_fire goals) a signed pixel URL hint. Batched
        all-time conversion/revenue totals are populated only on the goals list
        endpoint.
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
            - pixel_fire
            - webhook_hit
            - manual
            - tag_added
            - custom_event
        config:
          type: object
          additionalProperties: true
        value_cents:
          type:
            - 'null'
            - integer
          description: Monetary value credited per conversion, in minor units.
        lookback_days:
          type: integer
          description: Attribution lookback window in days.
        attribution_model:
          type: string
          enum:
            - last_touch
            - first_touch
            - linear
            - time_decay
        enabled:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        pixel_url:
          type: string
          description: >-
            Copy-paste tracking-pixel URL hint. Present only for pixel_fire
            goals.
        total_conversions:
          type: integer
          description: >-
            All-time recorded conversions. Populated only on the paginated list
            endpoint.
        total_revenue_cents:
          type: integer
          description: >-
            All-time revenue across this goal's conversions, in minor units.
            List endpoint only.
  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_*)

````