List experiments
The store’s A/B tests, newest first, each with its ARMS. The variants are on the list as well as the detail read, because an experiment without them is a name: the arms are what say what the test actually changes. Draft and archived tests are included. Use ?status=running for the live ones. created_by is NOT published. It is the internal user id of the staff member who filed the test, and read_experiments is a grant over the optimize programme’s data rather than over the merchant’s staff directory. A price experiment’s variant config sets the amount a shopper is charged, either as an absolute per-currency price or as a signed basis-points delta applied to every variant of a product or a whole collection. It is readable here and writable nowhere on this API: no write_experiments scope exists to be minted.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Query Parameters
Only running experiments serve to shoppers. Omit it for every status: an archived test is what a historical result belongs to and a draft is what the merchant is about to launch, so an unfiltered list is the right default for a client syncing tests outward.
draft, running, paused, concluded, archived The lever a variant config targets. price is the one to watch: those variant configs set the amount a shopper is charged.
content, price, offer, shipping, checkout, combination test is a randomised A/B split measured against a control. personalization is an always-on targeted experience exempt from the holdback and the ramp, so its result snapshots carry no meaningful lift and a client reading lift should filter to test.
test, personalization Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.
1 <= x <= 100The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.
