Read one collection version A/B test with its results

Error

A valid request URL is required to generate request examples

{
  "test_id": "<string>",
  "collection_id": "<string>",
  "name": "<string>",
  "variant_a_version_uuid": "<string>",
  "variant_b_version_uuid": "<string>",
  "scope_type": "all",
  "market_group_ids": [
    "<string>"
  ],
  "applies_to_market_ids": [
    "<string>"
  ],
  "traffic_split": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "status": "running",
  "promoted_variant": "A",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_email": "<string>",
  "stats": {
    "by_variant": {
      "A": {
        "page_views": 123,
        "clicks": 123,
        "add_to_carts": 123,
        "purchases": 123,
        "click_through_rate": 123,
        "add_to_cart_rate": 123,
        "conversion_rate": 123
      },
      "B": {
        "page_views": 123,
        "clicks": 123,
        "add_to_carts": 123,
        "purchases": 123,
        "click_through_rate": 123,
        "add_to_cart_rate": 123,
        "conversion_rate": 123
      }
    },
    "by_market_and_variant": [
      {
        "market_id": "<string>",
        "variant": "A",
        "page_views": 123,
        "clicks": 123,
        "add_to_carts": 123,
        "purchases": 123
      }
    ],
    "lift_b_over_a": {
      "page_views": 123,
      "clicks": 123,
      "add_to_carts": 123,
      "purchases": 123,
      "conversion_rate": 123
    },
    "significance": {
      "purchases": {
        "is_significant": true,
        "p_value": 123,
        "method": "two_proportion_z_test"
      },
      "add_to_carts": {
        "is_significant": true,
        "p_value": 123,
        "method": "two_proportion_z_test"
      },
      "clicks": {
        "is_significant": true,
        "p_value": 123,
        "method": "two_proportion_z_test"
      }
    },
    "time_series": [
      {
        "day": "<string>",
        "variant": "A",
        "value": 123
      }
    ]
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

collections

{collection_id}

ab-tests

{test_id}

Error

A valid request URL is required to generate request examples

{
  "test_id": "<string>",
  "collection_id": "<string>",
  "name": "<string>",
  "variant_a_version_uuid": "<string>",
  "variant_b_version_uuid": "<string>",
  "scope_type": "all",
  "market_group_ids": [
    "<string>"
  ],
  "applies_to_market_ids": [
    "<string>"
  ],
  "traffic_split": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "status": "running",
  "promoted_variant": "A",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_email": "<string>",
  "stats": {
    "by_variant": {
      "A": {
        "page_views": 123,
        "clicks": 123,
        "add_to_carts": 123,
        "purchases": 123,
        "click_through_rate": 123,
        "add_to_cart_rate": 123,
        "conversion_rate": 123
      },
      "B": {
        "page_views": 123,
        "clicks": 123,
        "add_to_carts": 123,
        "purchases": 123,
        "click_through_rate": 123,
        "add_to_cart_rate": 123,
        "conversion_rate": 123
      }
    },
    "by_market_and_variant": [
      {
        "market_id": "<string>",
        "variant": "A",
        "page_views": 123,
        "clicks": 123,
        "add_to_carts": 123,
        "purchases": 123
      }
    ],
    "lift_b_over_a": {
      "page_views": 123,
      "clicks": 123,
      "add_to_carts": 123,
      "purchases": 123,
      "conversion_rate": 123
    },
    "significance": {
      "purchases": {
        "is_significant": true,
        "p_value": 123,
        "method": "two_proportion_z_test"
      },
      "add_to_carts": {
        "is_significant": true,
        "p_value": 123,
        "method": "two_proportion_z_test"
      },
      "clicks": {
        "is_significant": true,
        "p_value": 123,
        "method": "two_proportion_z_test"
      }
    },
    "time_series": [
      {
        "day": "<string>",
        "variant": "A",
        "value": 123
      }
    ]
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

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.

Path Parameters

collection_id

string

required

Numeric Shopify collection id.

test_id

string

required

The test's id.

Query Parameters

merchant_id

string

required

Lite merchant id, e.g. shopify-<shop id>.

Response

The test and its results.

test_id

string

required

collection_id

string

required

name

string

required

variant_a_version_uuid

string

required

variant_b_version_uuid

string

required

scope_type

enum<string>

required

Available options:

all,

market_groups

market_group_ids

string[]

required

applies_to_market_ids

string[]

required

The scope resolved to numeric Shopify market ids, sorted; two running tests on a collection never share one.

traffic_split

integer

required

Percent of traffic routed to variant B (10–90).

start_date

string<date-time>

required

end_date

string<date-time>

required

status

enum<string>

required

Available options:

running,

ended,

winner_promoted

promoted_variant

enum<string> | null

required

Available options:

A,

B,

null

created_at

string<date-time>

required

created_by_email

string

required

Always empty: the test is storefront-readable.

stats

object | null

required

Null before the start date, or when analytics are unavailable.

Show child attributes