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>"
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}List a collection's version A/B tests
Returns the collection’s version A/B tests (every status unless status narrows it), read from their Shopify metaobjects. Read-only.
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>"
}
]{
"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.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Comma-separated statuses to keep (running, ended, winner_promoted); absent = all.
Response
The tests.
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).
running, ended, winner_promoted 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.
order, full Always empty (the test is storefront-readable).
Was this page helpful?

