> ## Documentation Index
> Fetch the complete documentation index at: https://docs.depict.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Read one collection version A/B test with its results

> Returns the test plus its results so far: per-variant and per-market KPIs, B-over-A lift, significance and a daily series. Results are null before the start date or when analytics are unavailable. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /collections/{collection_id}/ab-tests/{test_id}
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /collections/{collection_id}/ab-tests/{test_id}:
    get:
      summary: Read one collection version A/B test with its results
      description: >-
        Returns the test plus its results so far: per-variant and per-market
        KPIs, B-over-A lift, significance and a daily series. Results are null
        before the start date or when analytics are unavailable. Read-only.
      operationId: collectionAbTest
      parameters:
        - schema:
            type: string
            description: Numeric Shopify collection id.
          required: true
          description: Numeric Shopify collection id.
          name: collection_id
          in: path
        - schema:
            type: string
            description: The test's id.
          required: true
          description: The test's id.
          name: test_id
          in: path
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: query
      responses:
        '200':
          description: The test and its results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionVersionAbTestDetail'
        '400':
          description: The merchant has no Shopify configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: >-
            Merchant not found for this caller, or no such test on the
            collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    CollectionVersionAbTestDetail:
      allOf:
        - $ref: '#/components/schemas/CollectionVersionAbTest'
        - type: object
          properties:
            stats:
              anyOf:
                - $ref: '#/components/schemas/CollectionVersionAbTestStats'
                - type: 'null'
              description: Null before the start date, or when analytics are unavailable.
          required:
            - stats
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    CollectionVersionAbTest:
      type: object
      properties:
        test_id:
          type: string
        collection_id:
          type: string
        name:
          type: string
        variant_a_version_uuid:
          type: string
        variant_b_version_uuid:
          type: string
        scope_type:
          type: string
          enum:
            - all
            - market_groups
        market_group_ids:
          type: array
          items:
            type: string
        applies_to_market_ids:
          type: array
          items:
            type: string
          description: >-
            The scope resolved to numeric Shopify market ids, sorted; two
            running tests on a collection never share one.
        traffic_split:
          type: integer
          description: Percent of traffic routed to variant B (10–90).
        start_date:
          type: string
          format: date-time
        end_date:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - running
            - ended
            - winner_promoted
        promoted_variant:
          type:
            - string
            - 'null'
          enum:
            - A
            - B
            - null
        created_at:
          type: string
          format: date-time
        created_by_email:
          type: string
          description: 'Always empty: the test is storefront-readable.'
      required:
        - test_id
        - collection_id
        - name
        - variant_a_version_uuid
        - variant_b_version_uuid
        - scope_type
        - market_group_ids
        - applies_to_market_ids
        - traffic_split
        - start_date
        - end_date
        - status
        - promoted_variant
        - created_at
        - created_by_email
    CollectionVersionAbTestStats:
      type: object
      properties:
        by_variant:
          type: object
          properties:
            A:
              $ref: '#/components/schemas/CollectionVersionAbTestVariantKpis'
            B:
              $ref: '#/components/schemas/CollectionVersionAbTestVariantKpis'
          required:
            - A
            - B
        by_market_and_variant:
          type: array
          items:
            type: object
            properties:
              market_id:
                type: string
              variant:
                type: string
                enum:
                  - A
                  - B
              page_views:
                type: number
              clicks:
                type: number
              add_to_carts:
                type: number
              purchases:
                type: number
            required:
              - market_id
              - variant
              - page_views
              - clicks
              - add_to_carts
              - purchases
        lift_b_over_a:
          type: object
          properties:
            page_views:
              type: number
            clicks:
              type: number
            add_to_carts:
              type: number
            purchases:
              type: number
            conversion_rate:
              type: number
          required:
            - page_views
            - clicks
            - add_to_carts
            - purchases
            - conversion_rate
          description: 'Fractions: 0.12 = B is 12% above A.'
        significance:
          type: object
          properties:
            purchases:
              $ref: '#/components/schemas/CollectionVersionAbTestSignificance'
            add_to_carts:
              $ref: '#/components/schemas/CollectionVersionAbTestSignificance'
            clicks:
              $ref: '#/components/schemas/CollectionVersionAbTestSignificance'
          required:
            - purchases
            - add_to_carts
            - clicks
        time_series:
          type: array
          items:
            type: object
            properties:
              day:
                type: string
              variant:
                type: string
                enum:
                  - A
                  - B
              value:
                type: number
            required:
              - day
              - variant
              - value
      required:
        - by_variant
        - by_market_and_variant
        - lift_b_over_a
        - significance
        - time_series
    CollectionVersionAbTestVariantKpis:
      type: object
      properties:
        page_views:
          type: number
        clicks:
          type: number
        add_to_carts:
          type: number
        purchases:
          type: number
        click_through_rate:
          type: number
        add_to_cart_rate:
          type: number
        conversion_rate:
          type: number
      required:
        - page_views
        - clicks
        - add_to_carts
        - purchases
        - click_through_rate
        - add_to_cart_rate
        - conversion_rate
    CollectionVersionAbTestSignificance:
      type: object
      properties:
        is_significant:
          type: boolean
        p_value:
          type: number
        method:
          type: string
          enum:
            - two_proportion_z_test
      required:
        - is_significant
        - p_value
        - method
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Shopify App Bridge session token of the embedded Depict: Search &
        Merchandising app. The shop in the token determines the merchant;
        merchant_id parameters must belong to that shop.

````