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

# Report lift for a personalization slot

> Compare two variants of a slot on the traffic each one actually received and report which converts better. Pass the baseline arm as `variant_a` — use `__default__` to make the segment's untagged fallback content the baseline, the closest this feature has to a holdout — the variant under test as `variant_b`, and the event name that counts as a conversion. Impressions come from the personalization events the web and mobile SDKs already send on every render, so nothing new has to be instrumented. The report returns each arm's impressions, conversions and conversion rate, the absolute and relative lift, a 95% confidence interval, a z-score, a p-value and whether the difference is significant. `state` is `no_traffic` while neither arm has been served and `collecting` while only one has, and the statistical fields stay null until both arms have traffic. A `segment_label` the platform does not recognise is treated as no filter.



## OpenAPI

````yaml /openapi.yaml get /api/v1/personalization/slots/{slot}/lift
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: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - 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: Telegram
    description: >-
      Telegram bring-your-own-bot channel: connect a bot, verify a chat against
      the shared sandbox bot, and read unified channel state. Production sends
      go through the Messaging API.
  - name: USSD
    description: >-
      Menu-driven USSD for feature phones: define a menu tree, simulate session
      steps, and host the tenant-scoped aggregator callback.
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Messaging Services
    description: >-
      Twilio MessagingService-parity containers bundling sender pool, opt-out
      list, inbound webhook, and sticky-sender/geomatch flags
  - name: Sender Pools
    description: >-
      Group sending numbers into pools with a selection strategy (sticky /
      round-robin / random) for outbound sends
  - name: Opt-Out Lists
    description: >-
      Per-list STOP / HELP / START keyword sets and auto-response copy (Twilio
      Advanced Opt-Out parity)
  - name: SMPP
    description: Tenant BYO-SMPP bind credentials and upstream termination carriers
  - name: Commerce
    description: >-
      Unified omnichannel conversational-commerce: cart/checkout state machine,
      cross-channel payment reconciliation, hosted pay-by-link, native WhatsApp
      checkout, and agentic-checkout payment mandates
  - 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/personalization/slots/{slot}/lift:
    get:
      tags:
        - Personalization
      summary: Report lift for a personalization slot
      description: >-
        Compare two variants of a slot on the traffic each one actually received
        and report which converts better. Pass the baseline arm as `variant_a` —
        use `__default__` to make the segment's untagged fallback content the
        baseline, the closest this feature has to a holdout — the variant under
        test as `variant_b`, and the event name that counts as a conversion.
        Impressions come from the personalization events the web and mobile SDKs
        already send on every render, so nothing new has to be instrumented. The
        report returns each arm's impressions, conversions and conversion rate,
        the absolute and relative lift, a 95% confidence interval, a z-score, a
        p-value and whether the difference is significant. `state` is
        `no_traffic` while neither arm has been served and `collecting` while
        only one has, and the statistical fields stay null until both arms have
        traffic. A `segment_label` the platform does not recognise is treated as
        no filter.
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 50
          in: query
          name: variant_a
          required: true
          description: >-
            Baseline arm — a variant name, or `__default__` for the segment's
            untagged default content.
        - schema:
            type: string
            minLength: 1
            maxLength: 50
          in: query
          name: variant_b
          required: true
          description: >-
            Treatment arm — the variant under test. Must differ from
            `variant_a`, otherwise the request is rejected.
        - schema:
            type: string
            minLength: 1
            maxLength: 100
            pattern: ^[a-zA-Z0-9_.-]+$
          in: query
          name: conversion_event
          required: true
          description: >-
            Name of the SDK event that counts as a conversion, e.g.
            `clicked_cta` or `purchase`.
        - schema:
            type: string
            minLength: 1
            maxLength: 64
          in: query
          name: segment_label
          required: false
          description: >-
            Report only on visitors in this segment (`champion`,
            `high_value_engaged`, `engaged`, `new`, `passive`, `at_risk`,
            `dormant`, `lost`). Unrecognised values are ignored.
        - schema:
            type: integer
            minimum: 1
            maximum: 365
            default: 30
          in: query
          name: since_days
          required: false
          description: Lookback window in days (1–365).
        - schema:
            type: string
            minLength: 1
            maxLength: 100
          in: path
          name: slot
          required: true
          description: Slot key to report on, e.g. `hero-banner`.
        - name: X-Test-Mode
          in: header
          required: false
          description: >-
            Sandbox opt-in for Clerk-session-authenticated requests. Set to
            `true` to route the call through the test-mode pipeline: no real
            provider delivery, no credits deducted, response `meta.test_mode:
            true`. **Ignored for live API keys (`dv_live_sk_*`)** —
            server-to-server clients must use a test-prefixed key
            (`dv_test_sk_*`) to exercise sandbox. Test-prefixed keys
            unconditionally enable sandbox regardless of this header.
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: >-
            The lift report — `data.arm_a` and `data.arm_b` carry each arm's
            impressions, conversions and conversion rate, and
            `data.absolute_lift_pct`, `data.relative_lift_pct`,
            `data.confidence_interval`, `data.z_score`, `data.p_value` and
            `data.is_significant` describe the difference. Those are null while
            `data.state` is `no_traffic` or `collecting`.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                description: >-
                  The lift report — `data.arm_a` and `data.arm_b` carry each
                  arm's impressions, conversions and conversion rate, and
                  `data.absolute_lift_pct`, `data.relative_lift_pct`,
                  `data.confidence_interval`, `data.z_score`, `data.p_value` and
                  `data.is_significant` describe the difference. Those are null
                  while `data.state` is `no_traffic` or `collecting`.
                properties:
                  data:
                    type: object
                    additionalProperties: true
                  meta:
                    type: object
                    additionalProperties: true
        '400':
          $ref: '#/components/responses/StandardError'
        '401':
          $ref: '#/components/responses/StandardError'
        '403':
          $ref: '#/components/responses/StandardError'
        '404':
          $ref: '#/components/responses/StandardError'
        '422':
          $ref: '#/components/responses/StandardError'
        '429':
          $ref: '#/components/responses/RateLimitedResponse'
        '500':
          $ref: '#/components/responses/StandardError'
components:
  responses:
    StandardError:
      description: >-
        Standard error envelope. `error.code` is machine-readable; see the
        [error reference](https://docs.orbit.devotel.io/reference/error-codes)
        for the catalogue.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - status
                properties:
                  code:
                    type: string
                    description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER)
                  message:
                    type: string
                    description: Human-readable error description
                  status:
                    type: integer
                    description: HTTP status code
                  details:
                    type: object
                    additionalProperties: true
                    description: Additional context about the error
              meta:
                type: object
                properties:
                  request_id:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  docs_url:
                    type: string
                    format: uri
                    description: Link to relevant error documentation
    RateLimitedResponse:
      description: >-
        Rate limit exceeded. Wait `error.retry_after` seconds (or read the
        `Retry-After` header) before retrying. Returned when the request would
        exceed the bucket identified by `X-RateLimit-Bucket`.
      headers:
        X-RateLimit-Limit:
          description: Total request quota for the current window.
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: >-
            Absolute unix-epoch-seconds timestamp at which the current window
            resets.
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Bucket:
          description: >-
            Name of the rate-limit bucket the request was bound by (e.g.
            `auth-write`, `money`, `agent-invoke`, or `custom:<max>/<window>`).
            Stripe-style — lets clients see which named cap they hit.
          schema:
            type: string
        RateLimit-Limit:
          description: >-
            draft-ietf-httpapi-ratelimit-headers no-prefix mirror of
            `X-RateLimit-Limit`. Some SDKs read only this form.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: >-
            draft-ietf-httpapi-ratelimit-headers no-prefix mirror of
            `X-RateLimit-Remaining`.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: >-
            draft-ietf-httpapi-ratelimit-headers no-prefix mirror — delta
            seconds from now until the window resets (NOT epoch).
          schema:
            type: integer
            minimum: 0
        Retry-After:
          description: >-
            RFC 7231 §7.1.3 — number of seconds the client should wait before
            retrying.
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - status
                  - retry_after
                properties:
                  code:
                    type: string
                    enum:
                      - RATE_LIMITED
                    description: >-
                      Always `RATE_LIMITED` — the global request-limiter 429.
                      Distinct from `RATE_LIMIT_EXCEEDED`, the live
                      per-recipient/per-tenant/per-resource frequency-cap 429
                      (not retired).
                  message:
                    type: string
                  status:
                    type: integer
                    enum:
                      - 429
                  retry_after:
                    type: integer
                    minimum: 1
                    description: >-
                      Seconds to wait before retrying. Mirrors `Retry-After`
                      header.
              meta:
                type: object
                properties:
                  request_id:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  docs_url:
                    type: string
                    format: uri
  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_*)

````