Skip to main content
GET
Error

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.

Query Parameters

merchant_id
string
required

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

traffic_split
integer
default:50

Percent of traffic that would go to variant B.

Required range: 10 <= x <= 90
markets
string

Comma-separated Shopify market ids the test would run in; absent means every market. The traffic read is scoped to them.

Response

The estimate.

traffic_read
boolean
required

False when the traffic read failed: the counts below are then zeros that say nothing about the collection.

visitors_last_28_days
integer
required
click_rate
number | null
required

Share of those visitors who clicked a product; null without visitors.

detectable_lift
number
required
days_to_detect
integer | null
required

Whole days a test at this traffic and split needs before a detectable_lift difference in click rate shows, readiness floor included. Null when the last 28 days give no pace or no clicks.

min_days
integer
required
min_visitors_per_variant
integer
required