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>"
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
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.
GET
/
collections
/
{collection_id}
/
ab-tests
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>"
}
]{
"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.
Available options:
all, market_groups The scope resolved to numeric Shopify market ids, sorted; 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 Always empty: the test is storefront-readable.
Was this page helpful?

