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",
"promoted_market_group_ids": [
"<string>"
],
"ended_at": "2023-11-07T05:31:56Z",
"variant_a_settings": {
"version_name": "<string>",
"sort_order": "ALPHA_ASC",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
}
],
"use_collection_specific_boost_bury": true,
"unpin_oos": true,
"first_product_ids": [
"<string>"
]
},
"variant_b_settings": {
"version_name": "<string>",
"sort_order": "ALPHA_ASC",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
}
],
"use_collection_specific_boost_bury": true,
"unpin_oos": true,
"first_product_ids": [
"<string>"
]
},
"treatment": "order",
"created_at": "2023-11-07T05:31:56Z",
"created_by_email": "<string>",
"stats": {
"primary_metric": "click_through_rate",
"verdict": "not_ready",
"leader": "A",
"guardrail_against": "conversion_rate",
"by_variant": {
"A": {
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123,
"block_clickers": 123,
"click_through_rate": 123,
"add_to_cart_rate": 123,
"conversion_rate": 123,
"block_click_rate": 123,
"units_per_order": 123
},
"B": {
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123,
"block_clickers": 123,
"click_through_rate": 123,
"add_to_cart_rate": 123,
"conversion_rate": 123,
"block_click_rate": 123,
"units_per_order": 123
}
},
"by_market_and_variant": [
{
"market_id": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123,
"block_clickers": 123
}
],
"comparisons": {
"click_through_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"add_to_cart_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"conversion_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"block_click_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
}
},
"revenue": {
"currency": "<string>",
"fx_fallback_orders": 123,
"excluded_currencies": [
"<string>"
],
"by_variant": {
"A": {
"revenue": 123,
"orders": 123,
"average_order_value": 123,
"revenue_per_visitor": 123
},
"B": {
"revenue": 123,
"orders": 123,
"average_order_value": 123,
"revenue_per_visitor": 123
}
},
"probability_b_beats_a": 123
},
"revenue_by_currency": [
{
"currency": "<string>",
"convertible": true,
"by_variant": {
"A": {
"revenue": 123,
"orders": 123,
"average_order_value": 123
},
"B": {
"revenue": 123,
"orders": 123,
"average_order_value": 123
}
}
}
],
"readiness": {
"ready": true,
"days_run": 123,
"min_days": 123,
"min_visitors_per_variant": 123,
"guardrails_ready": true,
"min_buyers_per_variant": 123,
"detectable_lift": 123,
"estimated_days_remaining": 123,
"estimated_ready_at": "2023-11-07T05:31:56Z",
"estimated_guardrails_ready_at": "2023-11-07T05:31:56Z"
},
"split_check": {
"expected_share_b": 123,
"observed_share_b": 123,
"p_value": 123,
"mismatch": true
},
"mixed_shoppers": 123,
"attribution_hours": 123,
"daily": [
{
"day": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"click_through_rate": {
"value": 123,
"low": 123,
"high": 123
},
"add_to_cart_rate": {
"value": 123,
"low": 123,
"high": 123
},
"conversion_rate": {
"value": 123,
"low": 123,
"high": 123
}
}
],
"by_device_and_variant": [
{
"device_type": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123
}
],
"by_shopper_type_and_variant": [
{
"shopper_type": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123
}
],
"segment_comparisons": [
{
"segment": "device_type",
"value": "<string>",
"click_through_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"conversion_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
}
}
]
},
"variant_features": {
"A": {
"content_block_ids": [
"<string>"
],
"product_duplicate_ids": [
"<string>"
],
"image_setting_ids": [
"<string>"
]
},
"B": {
"content_block_ids": [
"<string>"
],
"product_duplicate_ids": [
"<string>"
],
"image_setting_ids": [
"<string>"
]
}
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
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.
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",
"promoted_market_group_ids": [
"<string>"
],
"ended_at": "2023-11-07T05:31:56Z",
"variant_a_settings": {
"version_name": "<string>",
"sort_order": "ALPHA_ASC",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
}
],
"use_collection_specific_boost_bury": true,
"unpin_oos": true,
"first_product_ids": [
"<string>"
]
},
"variant_b_settings": {
"version_name": "<string>",
"sort_order": "ALPHA_ASC",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
}
],
"use_collection_specific_boost_bury": true,
"unpin_oos": true,
"first_product_ids": [
"<string>"
]
},
"treatment": "order",
"created_at": "2023-11-07T05:31:56Z",
"created_by_email": "<string>",
"stats": {
"primary_metric": "click_through_rate",
"verdict": "not_ready",
"leader": "A",
"guardrail_against": "conversion_rate",
"by_variant": {
"A": {
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123,
"block_clickers": 123,
"click_through_rate": 123,
"add_to_cart_rate": 123,
"conversion_rate": 123,
"block_click_rate": 123,
"units_per_order": 123
},
"B": {
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123,
"block_clickers": 123,
"click_through_rate": 123,
"add_to_cart_rate": 123,
"conversion_rate": 123,
"block_click_rate": 123,
"units_per_order": 123
}
},
"by_market_and_variant": [
{
"market_id": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123,
"block_clickers": 123
}
],
"comparisons": {
"click_through_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"add_to_cart_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"conversion_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"block_click_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
}
},
"revenue": {
"currency": "<string>",
"fx_fallback_orders": 123,
"excluded_currencies": [
"<string>"
],
"by_variant": {
"A": {
"revenue": 123,
"orders": 123,
"average_order_value": 123,
"revenue_per_visitor": 123
},
"B": {
"revenue": 123,
"orders": 123,
"average_order_value": 123,
"revenue_per_visitor": 123
}
},
"probability_b_beats_a": 123
},
"revenue_by_currency": [
{
"currency": "<string>",
"convertible": true,
"by_variant": {
"A": {
"revenue": 123,
"orders": 123,
"average_order_value": 123
},
"B": {
"revenue": 123,
"orders": 123,
"average_order_value": 123
}
}
}
],
"readiness": {
"ready": true,
"days_run": 123,
"min_days": 123,
"min_visitors_per_variant": 123,
"guardrails_ready": true,
"min_buyers_per_variant": 123,
"detectable_lift": 123,
"estimated_days_remaining": 123,
"estimated_ready_at": "2023-11-07T05:31:56Z",
"estimated_guardrails_ready_at": "2023-11-07T05:31:56Z"
},
"split_check": {
"expected_share_b": 123,
"observed_share_b": 123,
"p_value": 123,
"mismatch": true
},
"mixed_shoppers": 123,
"attribution_hours": 123,
"daily": [
{
"day": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"click_through_rate": {
"value": 123,
"low": 123,
"high": 123
},
"add_to_cart_rate": {
"value": 123,
"low": 123,
"high": 123
},
"conversion_rate": {
"value": 123,
"low": 123,
"high": 123
}
}
],
"by_device_and_variant": [
{
"device_type": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123
}
],
"by_shopper_type_and_variant": [
{
"shopper_type": "<string>",
"variant": "A",
"visitors": 123,
"clickers": 123,
"adders": 123,
"buyers": 123,
"orders": 123,
"units": 123
}
],
"segment_comparisons": [
{
"segment": "device_type",
"value": "<string>",
"click_through_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
},
"conversion_rate": {
"rate_a": 123,
"rate_b": 123,
"lift": 123,
"lift_low": 123,
"lift_high": 123,
"probability_b_beats_a": 123
}
}
]
},
"variant_features": {
"A": {
"content_block_ids": [
"<string>"
],
"product_duplicate_ids": [
"<string>"
],
"image_setting_ids": [
"<string>"
]
},
"B": {
"content_block_ids": [
"<string>"
],
"product_duplicate_ids": [
"<string>"
],
"image_setting_ids": [
"<string>"
]
}
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
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
Numeric Shopify collection id.
The test's id.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
The test and its results.
Available options:
all, market_groups The scope as sorted numeric Shopify market ids; two running tests on a collection never share one.
Percent of traffic routed to variant B (10–90).
Available options:
running, ended, winner_promoted Available options:
A, B, null Market groups the winner was published in, global being the main slot. Empty when it went to its own slot only, or before this field existed.
When the test ended. Null while running, or if ended before this field existed.
The variant's rules when the test started, so the results stay explained after the version is edited. Null on older tests.
Show child attributes
Show child attributes
The variant's rules when the test started, so the results stay explained after the version is edited. Null on older tests.
Show child attributes
Show child attributes
order: arms differ in product order only. full: also in content blocks, duplicates and image settings.
Available options:
order, full Always empty (the test is storefront-readable).
Null before the start date, or when analytics are unavailable.
Show child attributes
Show child attributes
The metaobject ids of each variant's content blocks, duplicates and image settings as served now: set at test start, replaced by refresh_variant. Null when they cannot be read.
Show child attributes
Show child attributes
Was this page helpful?