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

# Record a conversion for a goal

> Records one or more conversions against a goal — the manual/server-to-server counterpart to the tracking pixel. Attach a contact_id, an optional value_cents override and free-form metadata. Server-to-server callers may authenticate the contact by sending an `Authorization: HMAC <contactId>:<sig>` header (sig = HMAC-SHA256 of goalId:contactId with the tenant API secret); an unsigned external contact_id is never accepted. Returns the recorded conversion rows (201).



## OpenAPI

````yaml /openapi.yaml post /api/v1/analytics/goals/{id}/record
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/{id}/record:
    post:
      tags:
        - Analytics
      summary: Record a conversion for a goal
      description: >-
        Records one or more conversions against a goal — the
        manual/server-to-server counterpart to the tracking pixel. Attach a
        contact_id, an optional value_cents override and free-form metadata.
        Server-to-server callers may authenticate the contact by sending an
        `Authorization: HMAC <contactId>:<sig>` header (sig = HMAC-SHA256 of
        goalId:contactId with the tenant API secret); an unsigned external
        contact_id is never accepted. Returns the recorded conversion rows
        (201).
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Goal id.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                contact_id:
                  type: string
                  minLength: 1
                  description: Contact the conversion is attributed to.
                value_cents:
                  type: integer
                  minimum: 0
                  description: Per-conversion value override, in minor units.
                metadata:
                  type: object
                  additionalProperties: true
                  description: Free-form context stored on the conversion.
            example:
              contact_id: cont_5aa9d21f
              value_cents: 4999
              metadata:
                source: crm
                order_id: ord_10482
      responses:
        '201':
          description: The recorded conversion rows.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      written:
                        type: integer
                        description: Number of conversion rows written.
                      conversions:
                        type: array
                        items:
                          $ref: '#/components/schemas/AnalyticsGoalConversion'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  written: 1
                  conversions:
                    - id: conv_88ab12
                      goal_id: goal_7Fb2c1a7b
                      contact_id: cont_5aa9d21f
                      value_cents: 4999
                      attributed_message_id: msg_71ce90
                      attributed_campaign_id: null
                      attributed_agent_id: null
                      conversion_time: '2026-08-02T12:00:00.000Z'
                      metadata:
                        source: crm
                        order_id: ord_10482
                meta:
                  request_id: req_9f2c1a7b
                  timestamp: '2026-08-02T12:00:00.000Z'
components:
  schemas:
    AnalyticsGoalConversion:
      type: object
      description: >-
        A single recorded conversion for a goal, including the attributed
        contact/message/campaign/agent, its value and metadata.
      properties:
        id:
          type: string
        goal_id:
          type: string
        contact_id:
          type:
            - 'null'
            - string
        value_cents:
          type:
            - 'null'
            - integer
        attributed_message_id:
          type:
            - 'null'
            - string
        attributed_campaign_id:
          type:
            - 'null'
            - string
        attributed_agent_id:
          type:
            - 'null'
            - string
        conversion_time:
          type: string
          format: date-time
        metadata:
          type: object
          additionalProperties: 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_*)

````