{ "openapi": "3.1.0", "info": { "title": "Intelligems External API v25-10-beta (dev)", "version": "v25-10-beta", "description": "# Intelligems External API\n\nThe Intelligems External API provides programmatic access to manage A/B tests and personalization experiences.\n\n## Base URL\n\nAll API requests should be made to:\n\n```\nhttps://api.intelligems.io\n```\n\n## Authentication\n\nAll API requests require authentication using an API key. Include your API key in the `intelligems-access-token` header:\n\n```\nintelligems-access-token: your-api-key\n```\n\n## Rate Limiting\n\nIntelligems uses a token bucket rate limiter for the external API.\n\nEvery response includes the following rate-limit headers:\n\n- `x-ratelimit-limit` \u2014 bucket size for the endpoint\n- `x-ratelimit-remaining` \u2014 remaining tokens in the current bucket\n- `x-ratelimit-reset` \u2014 Unix timestamp in **milliseconds** at which the bucket next refills\n\nTypical limits in `v25-10-beta`:\n\n- Experience list/detail/resource/timeseries endpoints: burst `50` (refill `25` every 30 seconds)\n- Experience export endpoint: burst `20`\n- Sitewide analytics endpoints: burst `10` (refill `5` every 30 seconds)\n\nPer-endpoint values are authoritative; always rely on the response headers for the active limit.\n\n## Errors\n\nThe API uses the following HTTP status codes:\n\n- `200` - Success.\n- `400` - Validation error (invalid query/body values). See Validation Error Shape below.\n- `401` - Unauthorized (invalid or missing API key)\n- `404` - Resource not found\n- `429` - Rate limit exceeded\n- `500` - Internal server error\n\n### Validation Error Shape\n\nFor invalid query/body values, the response returns HTTP `400` with this structure:\n\n```json\n{\n \"errors\": [],\n \"properties\": {\n \"fieldName\": {\n \"errors\": [\"Validation message\"]\n }\n }\n}\n```\n\nThe top-level `errors` array is reserved for request-level errors not attributable to a specific field and is empty for typical field-validation failures; per-field messages live under `properties..errors`.\n\n### Unauthorized Error Messages\n\nUnauthorized responses use an `error` string. Depending on auth failure mode, clients may see either `\"Unauthorized\"` or `\"Unauthorized!\"`.\n\n## Analytics Requests\n\nUse `POST /analytics/resource/{experienceId}` for experience analysis requests. It accepts filters and all other request settings in the JSON payload.\n\nFor store-level analytics, use the sitewide endpoints:\n\n- `POST /analytics/sitewide/snapshot` \u2014 summary KPI metrics with period-over-period percent changes, with optional audience segmentation\n- `POST /analytics/sitewide/timeseries` \u2014 metric-over-time data with configurable granularity and optional audience segmentation\n- `POST /analytics/sitewide/order-distribution` \u2014 order value histogram (KDE/CDF) and unit mix breakdown\n\nThe legacy `GET /analytics/resource/{experienceId}` endpoint is deprecated, is available during the beta only as a compatibility path, and will be removed when the beta version ends.\n\n`GET /experiences-list` supports optional `limit`, `page`, `status`, and `category` query parameters. `page` is 1-indexed (`page >= 1`). Valid `status` values: `pending`, `started`, `ended`, `paused`. Valid `category` values: `experiment`, `personalization`.\n\n`GET /experiences/{experienceId}` returns a wrapped response body in the shape `{ \"experience\": { ... } }`.\n\n## Filters Reference\n\nAnalytics endpoints (`POST /analytics/resource/{experienceId}` and the `POST /analytics/sitewide/*` endpoints) accept a `filters` parameter to narrow the result data as a **JSON object** in the request body.\n\nThe deprecated `GET /analytics/resource/{experienceId}` endpoint does not accept the new filters contract. It remains available only during the beta for the original query-parameter shape and will be removed when the beta version ends.\n\nAll filter fields are optional. Omit a field or set it to `null` to skip that filter.\n\n### Dimension Filters\n\n| Field | Type | Description |\n| ----------------------- | -------- | --------------------------------------------- |\n| `deviceType` | string | `\"any\"`, `\"mobile\"`, or `\"desktop\"` |\n| `visitorType` | string | `\"any\"`, `\"new\"`, or `\"returning\"` |\n| `countryCodes` | string[] | ISO 3166-1 alpha-2 codes, e.g. `[\"US\", \"GB\"]` |\n| `sourceSitesOrChannels` | string[] | Traffic channel names (see list below) |\n\n**Available traffic channels:** `Referral`, `All Social`, `Organic Social`, `Paid Social`, `Organic Search`, `Paid Search`, `Paid Shopping`, `Email`, `Google`, `Facebook`, `Instagram`, `Linktree`, `TikTok`, `Twitter`, `Direct`, `SMS`, `Meta`, `Youtube`, `Other`\n\n### Page & URL Filters\n\n| Field | Type | Description |\n| ------------- | ------ | --------------------------------------------------------------------------------- |\n| `landingPage` | object | `{ landingPageUrlPath: string, landingPageUrlPathFilterType: operator }` |\n| `urlParam` | object | `{ queryParam: string, queryParamValue: string, queryParamFilterType: operator }` |\n\n**Match operators** for `landingPageUrlPathFilterType`: `equals`, `contains`, `startsWith`, `endsWith`, `doesNotEqual`, `doesNotContain`, `doesNotStartWith`, `doesNotEndWith`, `isNull`, `isNotNull`\n\n**Match operators** for `queryParamFilterType`: all of the above plus `regex`\n\n### User Behavior Filters\n\n| Field | Type | Description |\n| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------ |\n| `userBehavior` | object | `{ viewedCheckout?: boolean, addedToCart?: boolean, viewedProductPage?: boolean, viewedCollectionPage?: boolean }` |\n| `reachedCheckoutStage` | string | `\"any\"`, `\"started\"`, `\"contact_info_submitted\"`, `\"address_info_submitted\"`, `\"added_to_cart\"` |\n\n### Revenue & Order Filters\n\n| Field | Type | Description |\n| -------------------- | -------------- | ---------------------------------------------------- |\n| `minNetRevenue` | number | Minimum order net revenue (inclusive) |\n| `maxNetRevenue` | number | Maximum order net revenue (inclusive) |\n| `minShippingRevenue` | number | Minimum shipping revenue (inclusive) |\n| `maxShippingRevenue` | number | Maximum shipping revenue (inclusive) |\n| `shippingMethods` | string[] | Shipping method names to include |\n| `currency` | string[] | ISO 4217 codes, e.g. `[\"USD\", \"EUR\"]` |\n| `maxZScore` | number \\| null | Outlier Z-score threshold; `null` disables filtering |\n\n### Custom Events Filters\n\n| Field | Type | Description |\n| ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `triggeredCustomEvents` | string[] | Custom event identifiers. You can find the id for your custom event in the GET https://api.intelligems.io/v25-10-beta/experiences payload. |\n| `customEventsFilterType` | string | `\"any\"` (at least one), `\"all\"` (every event), `\"none\"` (none of the events) |\n\n### Product Filters\n\n| Field | Type | Description |\n| ------------------------ | -------- | --------------------------------------- |\n| `experimentProductsOnly` | boolean | Only include products in the experiment |\n| `onlyProductIds` | string[] | Shopify product IDs to include |\n| `onlyProductHandles` | string[] | Shopify product handles to include |\n\n### Advanced Targeting\n\n| Field | Type | Description |\n| -------------------------------------- | ----- | -------------------------------------------------- |\n| `pageTargeting` | array | Expression groups for page-level targeting |\n| `productTargeting` | array | Expression groups for product-level targeting |\n| `applyExperienceTargetingExperienceId` | UUID | Reuse targeting config from an existing experience |\n\n**Page targeting** \u2014 each group has `type` (one of: `utm`, `url`, `urlPath`, `device`, `visitor`, `trafficSource`, `country`, `referrer`, `cookie`, `klaviyo`, `landingPage`) and `queries` array. Each query: `{ key: string, value: string, filter: matchOperator, type: filterType }`.\n\n**Product targeting** \u2014 each group has `type` (one of: `productId`, `collection`, `tag`, `price`, `inventory`) and `queries` array. Each query: `{ key: productAttribute, value: string | number, filter: productOperator, type: productAttribute }`. Product operators: `includes`, `doesNotInclude`, `greaterThan`, `lessThan`.\n\n### Example Filter Object\n\n```json\n{\n \"deviceType\": \"mobile\",\n \"countryCodes\": [\"US\", \"CA\"],\n \"sourceSitesOrChannels\": [\"Paid Search\", \"Email\"],\n \"landingPage\": {\n \"landingPageUrlPath\": \"/collections/sale\",\n \"landingPageUrlPathFilterType\": \"startsWith\"\n },\n \"userBehavior\": {\n \"addedToCart\": true\n },\n \"minNetRevenue\": 10,\n \"maxNetRevenue\": 500,\n \"maxZScore\": 3\n}\n```\n\nFor the resource and sitewide POST endpoints, send the filter object directly in the JSON body under `filters`.\n" }, "servers": [ { "url": "https://api.intelligems.io", "description": "Dev" } ], "tags": [ { "name": "Fetch Experience Data" }, { "name": "Create Experience", "description": "The following experience types are supported by the Intelligems Experiments API:\n\n- `content/advanced` \u2014 Advanced content test (custom CSS/JS injection)\n- `content/onsiteEdits` \u2014 Onsite edits (visual editor changes)\n- `content/url` \u2014 URL redirects\n- `content/theme` \u2014 Theme redirects\n- `content/template` \u2014 Template redirects\n- `personalization` \u2014 Personalization rules\n- `personalization/offer` \u2014 Offer test (structured discount campaigns configured via the `offer` field on each variation)\n\nThe following test types are not currently supported via this API:\n\n- Checkout Blocks\n- Pricing\n- Shipping\n- Campaigns\n\nAll fields (experience metadata, variations, audience, page targeting, and key metrics) are nested inside a single `experience` object in the request body." }, { "name": "Update Experience", "description": "Updates an existing experience. This is a full PUT replacement \u2014 the entire experience configuration is replaced with the provided data.\n\nAll required fields must be included in every request. Any optional fields omitted will be reset to their defaults.\n\nAll nested entities (variations, key metrics, page targeting, audience) must include their `id` field from the original GET response. All fields are nested inside a single `experience` object in the request body." }, { "name": "Perform Experience Action", "description": "Lifecycle actions for managing experience state transitions (start, pause, end)." }, { "name": "Fetch Sitewide Analytics" }, { "name": "07-get-experience-export" }, { "name": "08-get-holiday-benchmark-data" } ], "paths": { "/v25-10-beta/analytics/event/snapshot": { "post": { "tags": [ "08-get-holiday-benchmark-data" ], "security": [ { "intelligems_access_token": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "BFCM", "laborDay", "memorialDay", "presidentsDay" ], "description": "Seasonal event identifier. Supported values: \"BFCM\" (Black Friday / Cyber Monday), \"laborDay\", \"memorialDay\", \"presidentsDay\"." }, "metric": { "type": "string", "enum": [ "revenue", "orders", "priceLevels" ], "description": "Metric to return. Supported values: \"revenue\" (net revenue), \"orders\" (order count), \"priceLevels\" (average unit price)." }, "year": { "description": "Which year of the event to fetch (e.g. 2025 for BFCM 2025). Defaults to the most recently completed occurrence of the event. The prior-year comparison cohort is always year - 1. For hourly granularity, leave this unset or pass a year matching `end`'s year \u2014 passing a mismatched year + end will yield nonsensical results.", "type": "integer", "minimum": 2021, "maximum": 2026 }, "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "Required. Start of analysis period as an ISO 8601 datetime string. Used to size the window before the event (days-before-holiday); does not influence which event year is fetched. For hourly granularity, ignored. To match the Intelligems dashboard's Q4 view, pass Oct 1 of the event year (58 days before BFCM)." }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "Required. End of analysis period as an ISO 8601 datetime string. Used to size the window after the event (days-after-holiday); does not influence which event year is fetched. For hourly granularity this is interpreted as \"the day to analyze\" and is expected to fall within `year`. To match the Intelligems dashboard's Q4 view, pass Dec 31 of the event year (33 days after BFCM)." } }, "required": [ "event", "metric", "start", "end" ] } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code for monetary values (e.g. 'USD')." }, "snapshot": { "type": "object", "properties": { "periodToDateValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The brand's period-to-date actual value for the selected metric across the event window." }, "vsLastYear": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Percent change of the brand's period-to-date value vs the same period in the prior event year (e.g. 0.12 = +12%)." }, "avgDailyIndexPercent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The brand's average daily value as a percent of its own full-day baseline, across the event window. Maps to the dashboard's 'Avg Daily {Metric} (% of typical day)' tile." }, "currentIndexPercent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The industry-wide average daily index across the event window (percent of full-day baseline, aggregated across the ~1,000-brand basket). Maps to the dashboard's 'Index (% of typical day)' tile." } }, "required": [ "periodToDateValue", "vsLastYear", "avgDailyIndexPercent", "currentIndexPercent" ], "additionalProperties": false, "description": "KPI snapshot covering the brand's period-to-date event metrics." } }, "required": [ "currency", "snapshot" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/analytics/event/timeseries": { "post": { "tags": [ "08-get-holiday-benchmark-data" ], "security": [ { "intelligems_access_token": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "BFCM", "laborDay", "memorialDay", "presidentsDay" ], "description": "Seasonal event identifier. Supported values: \"BFCM\" (Black Friday / Cyber Monday), \"laborDay\", \"memorialDay\", \"presidentsDay\"." }, "metric": { "type": "string", "enum": [ "revenue", "orders", "priceLevels" ], "description": "Metric to return. Supported values: \"revenue\" (net revenue), \"orders\" (order count), \"priceLevels\" (average unit price)." }, "xAxis": { "type": "string", "enum": [ "actualDate", "daysFromEvent" ], "description": "How each datapoint's `dt` is labeled. \"actualDate\" returns an ISO 8601 datetime; \"daysFromEvent\" returns a signed integer string (e.g. \"-3\", \"0\", \"2\") relative to the event day." }, "granularity": { "type": "string", "enum": [ "hourly", "daily" ], "description": "\"hourly\" returns one datapoint per hour for the event day (uses the holiday_benchmarking_single_day dataset). \"daily\" returns one datapoint per day across a range spanning the event (uses holiday_benchmarking_multiple_days)." }, "mode": { "type": "string", "enum": [ "index", "brand", "brandWithIndex" ], "description": "\"index\" returns industry-wide index values only (currentYearIndex, priorYearIndex). \"brand\" returns the caller's brand actuals vs baseline (currentValue, baselineValue, priorYearValue). \"brandWithIndex\" returns brand actuals plus the brand's own index (brandIndex) and industry index overlays." }, "year": { "description": "Which year of the event to fetch (e.g. 2025 for BFCM 2025). Defaults to the most recently completed occurrence of the event. The prior-year comparison cohort is always year - 1. For hourly granularity, leave this unset or pass a year matching `end`'s year \u2014 passing a mismatched year + end will yield nonsensical results.", "type": "integer", "minimum": 2021, "maximum": 2026 }, "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "Required. Start of analysis period as an ISO 8601 datetime string. Used to size the window before the event (days-before-holiday); does not influence which event year is fetched. For hourly granularity, ignored. To match the Intelligems dashboard's Q4 view, pass Oct 1 of the event year (58 days before BFCM)." }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "Required. End of analysis period as an ISO 8601 datetime string. Used to size the window after the event (days-after-holiday); does not influence which event year is fetched. For hourly granularity this is interpreted as \"the day to analyze\" and is expected to fall within `year`. To match the Intelligems dashboard's Q4 view, pass Dec 31 of the event year (33 days after BFCM)." } }, "required": [ "event", "metric", "xAxis", "granularity", "mode", "start", "end" ] } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code for monetary values (e.g. 'USD')." }, "data": { "type": "array", "items": { "type": "object", "properties": { "dt": { "type": "string", "description": "Datapoint label \u2014 an ISO 8601 datetime (when xAxis='actualDate') or a signed day offset as a string (when xAxis='daysFromEvent')." }, "dayOffset": { "description": "Signed integer event-offset for this datapoint (0 = event day, negative = before, positive = after). Present on daily-granularity responses; omitted on hourly responses.", "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "currentValue": { "description": "Brand actual value for the selected metric during the current event year. Populated when mode is 'brand' or 'brandWithIndex'.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "baselineValue": { "description": "Brand typical-day baseline value for the selected metric. Populated when mode is 'brand' or 'brandWithIndex'.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "priorYearValue": { "description": "Brand actual value for the selected metric during the prior event year. Populated when mode is 'brand' or 'brandWithIndex'.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currentYearIndex": { "description": "Industry-wide index value (percent of full-day baseline) for the current event year. Populated when mode is 'index' or 'brandWithIndex'.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "priorYearIndex": { "description": "Industry-wide index value for the prior event year. Populated when mode is 'index' or 'brandWithIndex'.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "brandIndex": { "description": "The brand's own value expressed as a percent of its full-day baseline. Populated when mode is 'brandWithIndex'.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "dt" ], "additionalProperties": false }, "description": "Array of datapoints indexed by `dt`. Each entry may populate a subset of value fields depending on the requested `mode`." } }, "required": [ "currency", "data" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/analytics/experience/{experienceId}/export": { "post": { "tags": [ "07-get-experience-export" ], "description": "Export order-level or line-item-level data for an experience (A/B test) as a CSV file.\n\n## POST /analytics/experience/{experienceId}/export\n\nReturns a presigned S3 URL to download a CSV file containing the requested export data. The URL is valid for 15 minutes.\n\n### Parameters\n\n- `experienceId` (path) \u2014 **required**. UUID of the experience.\n- `exportType` \u2014 **required**. Type of export: `orders` or `order_line_items` (see table below).\n- `startTs` \u2014 optional 10-digit epoch timestamp in seconds. Defaults to experience start date.\n- `endTs` \u2014 optional 10-digit epoch timestamp in seconds. Defaults to now or experience end date.\n- `filters` \u2014 optional analytics filters object. See below and the Filters Reference for available fields.\n\n### Export Types\n\n| Value | Description |\n| ------------------ | ---------------------------------------------------------------------------------------------- |\n| `orders` | Order-level data \u2014 one row per order with revenue, discount, variation assignment, and visitor |\n| `order_line_items` | Line-item-level data \u2014 one row per line item with product, quantity, price, and variation |\n\n### Filters\n\nThis endpoint accepts the same filters as `POST /analytics/resource/{experienceId}`. Key filters include:\n\n| Field | Type | Description |\n| ------------------------ | -------- | --------------------------------------------------------- |\n| `deviceType` | string | `\"any\"`, `\"mobile\"`, or `\"desktop\"` |\n| `visitorType` | string | `\"any\"`, `\"new\"`, or `\"returning\"` |\n| `countryCodes` | string[] | ISO 3166-1 alpha-2 codes, e.g. `[\"US\", \"GB\"]` |\n| `sourceSitesOrChannels` | string[] | Traffic channel names (see Filters Reference) |\n| `userBehavior` | object | Visitor behavior filter (see sub-fields below) |\n| `experimentProductsOnly` | boolean | Only include products in the experiment (target products) |\n| `onlyProductIds` | string[] | Shopify product IDs to include |\n| `onlyProductHandles` | string[] | Shopify product handles to include |\n\n#### `userBehavior` sub-fields\n\nAll fields are optional booleans. Set to `true` to filter to only visitors who performed that action.\n\n| Field | Description |\n| ---------------------- | -------------------------------- |\n| `viewedProductPage` | Visitor viewed a product page |\n| `viewedCollectionPage` | Visitor viewed a collection page |\n| `addedToCart` | Visitor added an item to cart |\n| `viewedCheckout` | Visitor reached checkout |\n\nSee the Filters Reference section for the full list of available filter fields.\n\n### Response Structure\n\nThe response contains:\n\n| Field | Type | Description |\n| ---------------- | ------------ | ----------------------------------------------------------------------------- |\n| `exportType` | string | The export type requested (`orders` or `order_line_items`) |\n| `experienceId` | string | UUID of the experience |\n| `experienceName` | string | Display name of the experience |\n| `url` | string\\|null | Presigned S3 URL to download the CSV. Null if the export timed out. |\n| `expiresIn` | number | Seconds until the URL expires (900 = 15 minutes). 0 if url is null. |\n| `format` | string | Always `\"csv\"` |\n| `message` | string | Human-readable status (e.g. \"Export ready\", \"Export timed out, please retry\") |\n\n### Date Range Behavior\n\n- When `startTs` and `endTs` are omitted, the date range defaults to the experience's full lifetime (start date through end/pause date or now).\n- If the experience is **paused** or **ended**, the export is automatically truncated at the pause/end date.\n- If the provided `startTs` is before the experience start date, it is clamped to the experience start. Similarly, `endTs` is clamped to the experience end/pause date.\n\n### Presigned URL\n\nThe returned URL is a time-limited presigned S3 URL. It expires after **15 minutes** (900 seconds). After expiry, the URL returns a 403 Forbidden. Call the endpoint again to generate a new URL.", "security": [ { "intelligems_access_token": [] } ], "x-codeSamples": [ { "lang": "Shell", "label": "Basic orders export", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/export' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"exportType\": \"orders\"\n}'" }, { "lang": "Shell", "label": "Basic line items export", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/export' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"exportType\": \"order_line_items\"\n}'" }, { "lang": "Shell", "label": "Export with date range", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/export' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"exportType\": \"orders\",\n \"startTs\": \"1783238400\",\n \"endTs\": \"1785916799\"\n}'" }, { "lang": "Shell", "label": "Export with filters", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/export' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"exportType\": \"orders\",\n \"filters\": {\n \"deviceType\": \"mobile\",\n \"visitorType\": \"new\",\n \"countryCodes\": [\"US\", \"GB\"]\n }\n}'" }, { "lang": "Shell", "label": "Export with date range and filters", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/export' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"exportType\": \"order_line_items\",\n \"startTs\": \"1783238400\",\n \"endTs\": \"1785916799\",\n \"filters\": {\n \"deviceType\": \"desktop\",\n \"countryCodes\": [\"US\"],\n \"experimentProductsOnly\": true\n }\n}'" } ], "parameters": [ { "in": "path", "name": "experienceId", "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "exportType": { "type": "string", "enum": [ "orders", "order_line_items", "order_reconciliation" ], "description": "Type of export data to retrieve. 'orders' returns order-level data, 'order_line_items' returns line-item-level data." }, "startTs": { "description": "Optional analysis start timestamp as a 10-digit Unix epoch string in seconds. Defaults to the experience start date.", "type": "string" }, "endTs": { "description": "Optional analysis end timestamp as a 10-digit Unix epoch string in seconds. Defaults to now or the experience end date.", "type": "string" }, "filters": { "description": "Optional analytics filters object. Supports device, visitor, traffic source, country, product, and targeting filters.\n\nAnalytics filters object for narrowing experience/experiment result data.", "type": "object", "properties": { "deviceType": { "description": "Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.", "anyOf": [ { "type": "string", "enum": [ "any", "mobile", "desktop" ] }, { "type": "null" } ] }, "visitorType": { "description": "Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.", "anyOf": [ { "type": "string", "enum": [ "any", "new", "returning" ] }, { "type": "null" } ] }, "sourceSitesOrChannels": { "description": "Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.", "type": "array", "items": { "type": "string", "enum": [ "Referral", "All Social", "Organic Social", "Paid Social", "Organic Search", "Paid Search", "Paid Shopping", "Email", "Google", "Facebook", "Instagram", "Linktree", "TikTok", "Twitter", "Direct", "SMS", "Other", "Meta", "Link Tree", "Wunderkind Text", "Youtube", "any" ] } }, "landingPageFilters": { "description": "Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against \u2014 omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.", "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] } }, "required": [ "filterType" ] } }, "landingPageFiltersOperator": { "description": "How multiple items in landingPageFilters are combined. 'or' (default) \u2014 session matches if any filter item matches. 'and' \u2014 session must match every filter item.", "type": "string", "enum": [ "or", "and" ] }, "userBehavior": { "description": "Filter by visitor browsing behavior. Object with optional boolean flags: viewedCheckout, addedToCart, viewedProductPage, viewedCollectionPage. Set a flag to true to include only visitors who performed that action. Omit or null for flags you don't want to filter on. Multiple true flags are combined with AND logic.", "type": "object", "properties": { "viewedCheckout": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "addedToCart": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "viewedProductPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "viewedCollectionPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } } }, "countryCodes": { "description": "Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.", "type": "array", "items": { "type": "string" } }, "landingPageTypes": { "description": "Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.", "type": "array", "items": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] } }, "experimentProductsOnly": { "description": "When true, only include products that are part of the experiment. Only applies when analyzing an experience/experiment.", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "onlyProductIds": { "description": "Filter to only include specific Shopify product IDs (numeric strings).", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "onlyProductHandles": { "description": "Filter to only include specific Shopify product handles.", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } } } }, "required": [ "exportType" ] } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "exportType": { "type": "string", "enum": [ "orders", "order_line_items", "order_reconciliation" ], "description": "The type of export that was generated." }, "experienceId": { "type": "string", "description": "The UUID of the experience." }, "experienceName": { "type": "string", "description": "The display name of the experience." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Presigned S3 URL to download the CSV file. Valid for 15 minutes. Null if the export timed out or failed." }, "expiresIn": { "type": "number", "description": "Number of seconds until the presigned URL expires. 0 if url is null." }, "format": { "type": "string", "const": "csv", "description": "The file format of the export (always 'csv')." }, "message": { "type": "string", "description": "Human-readable status message." } }, "required": [ "exportType", "experienceId", "experienceName", "url", "expiresIn", "format", "message" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/analytics/experience/{experienceId}/timeseries": { "post": { "tags": [ "Fetch Experience Data" ], "description": "Retrieve per-variant time series data for an experience (A/B test).\n\n## POST /analytics/experience/{experienceId}/timeseries\n\nReturns metric values over time for each variation in the experiment, segmented by variation name. Use this data to compare variant performance over time and compute signals like \"win-day count\" (how many periods a variant beat control).\n\n### Parameters\n\n- `experienceId` (path) \u2014 **required**. UUID of the experience.\n- `granularity` \u2014 optional time bucketing: `hour`, `day` (default), `week`, or `month`.\n- `mode` \u2014 `cumulative` (default, running totals) or `noncumulative` (per-bucket values).\n- `metrics` \u2014 optional array of metric enum values to include (see table below). Defaults to `conversion_rate`, `net_revenue_per_visitor`, `gross_profit_per_visitor`.\n- `startTs` \u2014 optional 10-digit epoch timestamp in seconds. Defaults to experience start date.\n- `endTs` \u2014 optional 10-digit epoch timestamp in seconds. Defaults to now or experience end date.\n- `filters` \u2014 optional analytics filters object. See below and the Filters Reference for available fields.\n\n### Available Metrics\n\nPass one or more of these enum values in the `metrics` array:\n\n| Value | Description |\n| -------------------------- | ------------------------- |\n| `conversion_rate` | Conversion rate |\n| `net_revenue_per_visitor` | Revenue per visitor (RPV) |\n| `gross_profit_per_visitor` | Profit per visitor (PPV) |\n| `aov` | Average order value |\n| `n_visitors` | Visitor count |\n| `n_orders` | Order count |\n| `net_revenue` | Total net revenue |\n\n### Filters\n\nThis endpoint accepts the same filters as `POST /analytics/resource/{experienceId}`. Key filters include:\n\n| Field | Type | Description |\n| ------------------------ | -------- | --------------------------------------------------------- |\n| `deviceType` | string | `\"any\"`, `\"mobile\"`, or `\"desktop\"` |\n| `visitorType` | string | `\"any\"`, `\"new\"`, or `\"returning\"` |\n| `countryCodes` | string[] | ISO 3166-1 alpha-2 codes, e.g. `[\"US\", \"GB\"]` |\n| `sourceSitesOrChannels` | string[] | Traffic channel names (see Filters Reference) |\n| `userBehavior` | object | Visitor behavior filter (see sub-fields below) |\n| `experimentProductsOnly` | boolean | Only include products in the experiment (target products) |\n| `onlyProductIds` | string[] | Shopify product IDs to include |\n| `onlyProductHandles` | string[] | Shopify product handles to include |\n\n#### `userBehavior` sub-fields\n\nAll fields are optional booleans. Set to `true` to filter to only visitors who performed that action.\n\n| Field | Description |\n| ---------------------- | -------------------------------- |\n| `viewedProductPage` | Visitor viewed a product page |\n| `viewedCollectionPage` | Visitor viewed a collection page |\n| `addedToCart` | Visitor added an item to cart |\n| `viewedCheckout` | Visitor reached checkout |\n\nSee the Filters Reference section for the full list of available filter fields.\n\n### Response Structure\n\nThe response contains a `segments` object keyed by variation name. Each segment has a `data` array of time-bucketed metric values. A `variations` array provides metadata including which variation is the control.\n\nEach data point includes a `dt` field as a formatted date string (not Unix epoch). Format depends on `granularity`:\n\n- `hour` / `day`: `\"YYYY-MM-DD HH:mm:ss\"`\n- `week` / `month`: `\"YYYY-MM-DD\"`\n\n### Date Range Behavior\n\n- When `startTs` and `endTs` are omitted, the date range defaults to the experience's full lifetime (start date through end/pause date or now).\n- If the experience is **paused** or **ended**, the response is automatically truncated at the pause/end date \u2014 no data points are returned after that point.\n- If the provided `startTs` is before the experience start date, it is clamped to the experience start. Similarly, `endTs` is clamped to the experience end/pause date.", "security": [ { "intelligems_access_token": [] } ], "x-codeSamples": [ { "lang": "Shell", "label": "Basic experience timeseries (daily, cumulative)", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/timeseries' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"granularity\": \"day\",\n \"mode\": \"cumulative\"\n}'" }, { "lang": "Shell", "label": "Experience timeseries with all metrics", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/timeseries' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"granularity\": \"day\",\n \"mode\": \"cumulative\",\n \"metrics\": [\n \"conversion_rate\",\n \"net_revenue_per_visitor\",\n \"gross_profit_per_visitor\",\n \"aov\",\n \"n_visitors\",\n \"n_orders\",\n \"net_revenue\"\n ]\n}'" }, { "lang": "Shell", "label": "Experience timeseries with filters", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/timeseries' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"granularity\": \"week\",\n \"mode\": \"cumulative\",\n \"metrics\": [\"conversion_rate\", \"net_revenue_per_visitor\"],\n \"filters\": {\n \"deviceType\": \"mobile\",\n \"visitorType\": \"new\"\n }\n}'" }, { "lang": "Shell", "label": "Hourly noncumulative timeseries", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/timeseries' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"granularity\": \"hour\",\n \"mode\": \"noncumulative\",\n \"metrics\": [\"conversion_rate\", \"net_revenue_per_visitor\"]\n}'" }, { "lang": "Shell", "label": "Experience timeseries with date range", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/experience/YOUR_EXPERIENCE_ID/timeseries' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"startTs\": \"1767250800\",\n \"endTs\": \"1769929199\",\n \"granularity\": \"day\",\n \"mode\": \"cumulative\"\n}'" } ], "parameters": [ { "in": "path", "name": "experienceId", "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "startTs": { "description": "Optional analysis start timestamp as a 10-digit Unix epoch string in seconds. Defaults to the experience start date.", "type": "string" }, "endTs": { "description": "Optional analysis end timestamp as a 10-digit Unix epoch string in seconds. Defaults to now or the experience end date.", "type": "string" }, "granularity": { "default": "day", "description": "Time bucket granularity. Supported values: hour, day, week, month. Defaults to day.", "type": "string", "enum": [ "hour", "day", "week", "month" ] }, "mode": { "default": "cumulative", "description": "Time series mode. Use 'cumulative' for running totals or 'noncumulative' for per-bucket values. Defaults to cumulative.", "type": "string", "enum": [ "cumulative", "noncumulative" ] }, "metrics": { "default": [ "conversion_rate", "net_revenue_per_visitor", "gross_profit_per_visitor" ], "description": "Array of metric names to include in the response. When omitted, defaults to conversion_rate, net_revenue_per_visitor, and gross_profit_per_visitor.", "type": "array", "items": { "type": "string", "enum": [ "conversion_rate", "net_revenue_per_visitor", "gross_profit_per_visitor", "aov", "n_visitors", "n_orders", "net_revenue" ] } }, "filters": { "description": "Optional analytics filters object. Supports device, visitor, traffic source, country, product, and targeting filters.\n\nAnalytics filters object for narrowing experience/experiment result data.", "type": "object", "properties": { "deviceType": { "description": "Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.", "anyOf": [ { "type": "string", "enum": [ "any", "mobile", "desktop" ] }, { "type": "null" } ] }, "visitorType": { "description": "Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.", "anyOf": [ { "type": "string", "enum": [ "any", "new", "returning" ] }, { "type": "null" } ] }, "sourceSitesOrChannels": { "description": "Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.", "type": "array", "items": { "type": "string", "enum": [ "Referral", "All Social", "Organic Social", "Paid Social", "Organic Search", "Paid Search", "Paid Shopping", "Email", "Google", "Facebook", "Instagram", "Linktree", "TikTok", "Twitter", "Direct", "SMS", "Other", "Meta", "Link Tree", "Wunderkind Text", "Youtube", "any" ] } }, "landingPageFilters": { "description": "Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against \u2014 omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.", "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] } }, "required": [ "filterType" ] } }, "landingPageFiltersOperator": { "description": "How multiple items in landingPageFilters are combined. 'or' (default) \u2014 session matches if any filter item matches. 'and' \u2014 session must match every filter item.", "type": "string", "enum": [ "or", "and" ] }, "userBehavior": { "description": "Filter by visitor browsing behavior. Object with optional boolean flags: viewedCheckout, addedToCart, viewedProductPage, viewedCollectionPage. Set a flag to true to include only visitors who performed that action. Omit or null for flags you don't want to filter on. Multiple true flags are combined with AND logic.", "type": "object", "properties": { "viewedCheckout": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "addedToCart": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "viewedProductPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "viewedCollectionPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } } }, "countryCodes": { "description": "Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.", "type": "array", "items": { "type": "string" } }, "landingPageTypes": { "description": "Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.", "type": "array", "items": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] } }, "experimentProductsOnly": { "description": "When true, only include products that are part of the experiment. Only applies when analyzing an experience/experiment.", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "onlyProductIds": { "description": "Filter to only include specific Shopify product IDs (numeric strings).", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "onlyProductHandles": { "description": "Filter to only include specific Shopify product handles.", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } } } } } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code for monetary values (e.g. 'USD')." }, "granularity": { "type": "string", "enum": [ "hour", "day", "week", "month" ], "description": "The granularity used for time bucketing." }, "mode": { "type": "string", "enum": [ "cumulative", "noncumulative" ], "description": "The time series mode used (cumulative or discrete)." }, "experienceId": { "type": "string", "description": "The UUID of the experience." }, "experienceName": { "type": "string", "description": "The display name of the experience." }, "variations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isControl": { "type": "boolean" } }, "required": [ "id", "name", "isControl" ], "additionalProperties": false }, "description": "Array of variation metadata objects. Each contains the variation id, name, and whether it is the control." }, "segments": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "dt": { "type": "string" } }, "required": [ "dt" ], "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } } }, "required": [ "data" ], "additionalProperties": false }, "description": "Time series data keyed by variation name. Each segment contains a data array of time-bucketed metric values." } }, "required": [ "currency", "granularity", "mode", "experienceId", "experienceName", "variations", "segments" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/analytics/resource/{experienceId}": { "get": { "tags": [ "Fetch Experience Data" ], "description": "Retrieve analytics data for a specific experience, including metrics, variations, and optionally graph images.\n\nThis legacy GET endpoint is deprecated, intentionally limited to the original query-parameter contract, and kept only as a beta compatibility path. Use the POST variant on the same path for all new integrations. The GET endpoint will be removed when the beta version ends.\n\nValid `view` values are `overview` and `audience`. The value `summary` is not supported. When `view=audience`, you must also provide the `audience` query parameter.\n\nThe legacy `start` and `end` query parameters must be 10-digit Unix epoch timestamps in seconds, not milliseconds.\n\nResponse payloads include `impact` (object with `est_monthly_revenue_increase`: the projected 30-day revenue lift from the best non-control variation vs. control, or `null` when there is insufficient data) plus distribution and ordering helpers such as `audienceOrder`, `histogram`, `kde`, and `cdf`.", "deprecated": true, "security": [ { "intelligems_access_token": [] } ], "x-codeSamples": [ { "lang": "Shell", "label": "Overview with date range + specific graph images", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111?start=1764199800&end=1764223200&graphs=conversion_rate%2Cnet_revenue_per_visitor%2Cadd_to_cart_rate' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data ''" }, { "lang": "Shell", "label": "Audience breakdown by device type", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111?view=audience&audience=device_type' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data ''" }, { "lang": "Shell", "label": "Audience breakdown by traffic source channel", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111?view=audience&audience=source_channel' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data ''" } ], "parameters": [ { "in": "query", "name": "graphs", "schema": { "description": "Comma-separated list of graph IDs to include in response. Only applicable for \"view=overview\" requests. Available options:\n\n- abandoned_cart_rate\n- abandoned_checkout_rate\n- add_to_cart_rate\n- avg_discount_per_all_orders\n- avg_discount_per_discounted_order\n- avg_product_revenue_per_unit\n- avg_units_per_order\n- checkout_address_submitted_rate\n- checkout_begin_rate\n- checkout_enter_contact_info_rate\n- conversion_rate\n- net_product_revenue_per_order\n- net_revenue_per_order\n- net_revenue_per_visitor\n- net_shipping_revenue_per_order\n- pct_orders_free_shipping\n- pct_subscription_orders\n- profit_per_order\n- profit_per_visitor\n- subscription_orders_per_visitor\n- subscription_product_revenue_per_order\n- subscription_profit_per_visitor\n- subscription_revenue_per_order\n- subscription_revenue_per_visitor\n- view_collection_page_rate\n- view_product_page_rate", "type": "string" }, "description": "Comma-separated list of graph IDs to include in response. Only applicable for \"view=overview\" requests. Available options:\n\n- abandoned_cart_rate\n- abandoned_checkout_rate\n- add_to_cart_rate\n- avg_discount_per_all_orders\n- avg_discount_per_discounted_order\n- avg_product_revenue_per_unit\n- avg_units_per_order\n- checkout_address_submitted_rate\n- checkout_begin_rate\n- checkout_enter_contact_info_rate\n- conversion_rate\n- net_product_revenue_per_order\n- net_revenue_per_order\n- net_revenue_per_visitor\n- net_shipping_revenue_per_order\n- pct_orders_free_shipping\n- pct_subscription_orders\n- profit_per_order\n- profit_per_visitor\n- subscription_orders_per_visitor\n- subscription_product_revenue_per_order\n- subscription_profit_per_visitor\n- subscription_revenue_per_order\n- subscription_revenue_per_visitor\n- view_collection_page_rate\n- view_product_page_rate" }, { "in": "query", "name": "graphOutput", "schema": { "default": "png", "description": "Output format for graph images. 'png' (default) uploads to S3 and returns a URL. 'base64' returns the raw base64-encoded PNG data inline.", "type": "string", "enum": [ "png", "base64" ] }, "description": "Output format for graph images. 'png' (default) uploads to S3 and returns a URL. 'base64' returns the raw base64-encoded PNG data inline." }, { "in": "query", "name": "view", "schema": { "default": "overview", "description": "Resource view to analyze. Supported values are 'overview' for variation-level metrics and 'audience' for a breakdown by the selected audience dimension.", "type": "string", "enum": [ "overview", "audience" ] }, "description": "Resource view to analyze. Supported values are 'overview' for variation-level metrics and 'audience' for a breakdown by the selected audience dimension." }, { "in": "query", "name": "audience", "schema": { "description": "Audience breakdown dimension returned when `view` is `audience`. This field is required when `view` is `audience`. Use one of the supported audience fields such as `device_type`, `visitor_type`, or `source_channel`.", "type": "string", "enum": [ "device_type", "visitor_type", "source_channel", "source_site", "country_code", "landing_page_full_path" ] }, "description": "Audience breakdown dimension returned when `view` is `audience`. This field is required when `view` is `audience`. Use one of the supported audience fields such as `device_type`, `visitor_type`, or `source_channel`." }, { "in": "query", "name": "analyticsViewType", "schema": { "description": "Optional analytics view preset used by the backend when building the analysis request.", "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ] }, "description": "Optional analytics view preset used by the backend when building the analysis request." }, { "in": "query", "name": "end", "schema": { "description": "Optional analysis end timestamp as a 10-digit Unix epoch string in seconds (not milliseconds).", "type": "string" }, "description": "Optional analysis end timestamp as a 10-digit Unix epoch string in seconds (not milliseconds)." }, { "in": "query", "name": "start", "schema": { "description": "Optional analysis start timestamp as a 10-digit Unix epoch string in seconds (not milliseconds).", "type": "string" }, "description": "Optional analysis start timestamp as a 10-digit Unix epoch string in seconds (not milliseconds)." } ], "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string", "enum": [ "order_line_items", "orders", "aiProfit", "variation_overview", "variation_audience", "variation_timeseries_discrete", "variation_timeseries_cumulative", "experience_countries", "variation_shipping_method", "variation_histogram", "variation_products", "variation_product_groups", "variation_order_unit_mix", "custom_events_plugin", "custom_events_server", "order_reconciliation", "order_reconciliation_export", "timeseries", "country_codes", "snapshots", "experience_shipping_methods", "timeseries_audience", "snapshots_audience", "holiday_benchmarking_single_day", "holiday_benchmarking_multiple_days", "order_distribution_histogram", "order_distribution_unit_mix", "conversion_snapshots", "conversion_funnel", "conversion_timeseries", "variation_post_metrics", "variation_post_metrics_audience" ] }, "latestRunTs": { "type": "number" }, "metrics": { "type": "array", "items": {}, "description": "Array of metric objects. Each metric object may contain the following fields (all optional):\n \n **Dimension Fields:**\n - variation_id (string, UUID): The variation identifier\n - dt (string): Timestamp for time series data\n - audience (string): Audience segment identifier\n \n **Metric Fields (alphabetical):**\n - abandoned_cart_rate: Rate of abandoned carts\n - abandoned_checkout_rate: Rate of abandoned checkouts\n - add_to_cart_rate: Add to cart rate\n - avg_discount_per_all_orders: Average discount amount across all orders\n - avg_discount_per_discounted_order: Average discount amount for orders with discounts\n - avg_product_revenue_per_unit: Average revenue per product unit\n - avg_units_per_order: Average number of units per order\n - checkout_address_submitted_rate: Rate of checkouts with address submitted\n - checkout_begin_rate: Checkout initiation rate\n - checkout_enter_contact_info_rate: Rate of checkouts with contact info entered\n - conversion_rate: Conversion rate metric with statistical details\n - gross_profit_per_order: Gross profit per order\n - gross_profit_per_visitor: Gross profit per visitor\n - n_orders: Number of orders\n - n_visitors: Number of visitors\n - net_product_revenue_per_order: Average product revenue per order\n - net_revenue: Total net revenue\n - net_revenue_per_order: Average revenue per order\n - net_revenue_per_visitor: Average revenue per visitor\n - net_shipping_revenue_per_order: Average shipping revenue per order\n - pct_orders_free_shipping: Percentage of orders with free shipping\n - pct_subscription_orders: Percentage of orders that are subscriptions\n - subscription_gross_profit_per_visitor: Gross profit from subscriptions per visitor\n - subscription_orders_per_visitor: Subscription orders per visitor\n - subscription_revenue_per_order: Revenue from subscriptions per order\n - subscription_revenue_per_visitor: Revenue from subscriptions per visitor\n - view_collection_page_rate: Collection page view rate\n - view_product_page_rate: Product page view rate\n \n Each statistical metric contains:\n - value (number): The metric value" }, "audienceOrder": {}, "histogram": {}, "kde": {}, "cdf": {}, "variations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "name": { "type": "string", "description": "Display name (e.g., 'Control', 'Variant A'). Unique within the experience." }, "percentage": { "type": "number", "description": "Traffic allocation weight. All percentages across sibling variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order in the analytics dashboard. 0-indexed." }, "priceChange": { "description": "Price adjustment amount for pricing-type experiences. Positive increases price, negative discounts. Use priceChange for simple price A/B tests; use offer for structured discount campaigns (tiered, BOGO, free shipping).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priceChangeUnit": { "description": "How priceChange is applied: as a percentage of the original price or a fixed monetary amount.", "anyOf": [ { "type": "string", "enum": [ "percent", "dollar" ] }, { "type": "null" } ] }, "priceRoundingType": { "description": "Rounding strategy applied after priceChange (e.g., round up, round down, charm pricing).", "anyOf": [ { "type": "string", "enum": [ "none", "nearest", "up", "down" ] }, { "type": "null" } ] }, "priceRoundingAmount": { "description": "Target value for rounding (e.g., 0.99 for charm pricing like $X.99).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onsiteEdits": { "default": [], "description": "DOM content modifications (text, HTML, image swaps, element removal). For CSS styling changes, use onsiteInjections instead.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "onsiteEditType": { "description": "Content modification strategy (html, text, image, or hide).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to locate on the page. Interpreted as regex when isRegex is true." }, "title": { "description": "Dashboard label for identifying this edit.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "When true, 'find' is treated as a regular expression.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content. Interpretation depends on onsiteEditType: HTML markup, plain text, or image URL.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping which DOM elements this edit targets (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "When true, this edit is temporarily disabled without being deleted.", "type": "boolean" }, "remove": { "default": false, "description": "When true, the matched element is removed from the DOM instead of having its content replaced.", "type": "boolean" }, "groupId": { "description": "Groups related edits together so they can be managed as a unit.", "type": "string" }, "isHtml": { "default": false, "type": "boolean" }, "isImage": { "default": false, "type": "boolean" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to the target (beforebegin, afterbegin, beforeend, afterend). Null means content replacement." }, "createdAtUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Server-generated. Read-only. Storefront URL where this edit was originally created via the visual editor." }, "createdAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname for locating images to replace. When set, images are found by URL match; when null, querySelectors is used instead." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "find", "isRegex", "replace", "querySelectors", "skip", "remove", "isHtml", "isImage", "insertType" ], "additionalProperties": false } }, "onsiteInjections": { "description": "CSS styling and custom JS injection. At most one per variation. For DOM content changes (text, images, HTML), use onsiteEdits instead.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "type" ], "additionalProperties": false, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "jsInjectionMode" ], "additionalProperties": false }, { "type": "null" } ] }, "offer": { "description": "Structured discount configuration (tiered volume discounts, cart-level discounts, gift-with-purchase, free shipping). Use offer for campaign/discount experiences; use priceChange for simple price A/B tests.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation this offer belongs to." }, "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "description": "Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "minimumUnits": { "default": 1, "type": "number" }, "maximumUnits": { "default": 1, "type": "number" }, "unitDiscount": { "default": 1, "type": "number" }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "minimumUnits", "maximumUnits", "unitDiscount", "discountTitle", "giftWithPurchaseTitle", "isFreeShipping", "isGiftWithPurchase", "autoAddGiftWithPurchase" ], "additionalProperties": false } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ], "additionalProperties": false } } }, "required": [ "type", "rules" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ], "additionalProperties": false }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] } }, "required": [ "id", "variationId", "enabled", "isTest", "isArchived", "name", "unitType", "discountType", "tiers", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount", "requireSameItem", "subscriptionApplicationType" ], "additionalProperties": false }, { "type": "null" } ] }, "offerId": { "description": "Server-generated. Read-only. References the associated offer. Populated when offer is set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "shippingRateGroups": { "description": "Shipping rate overrides. Only populated for shipping test experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupType": { "type": "string", "enum": [ "flatRate", "flatRateWithThreshold", "thresholdOnly", "tieredByPriceOrWeight", "custom" ] }, "position": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "amount": { "type": "number" }, "rateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rateType": { "type": "string", "enum": [ "amount", "threshold", "tier" ] }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SRD", "STD", "SZL", "THB", "TJS", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "min": { "default": 0, "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "conditionType": { "type": "string", "enum": [ "currency", "weight" ] }, "unit": { "anyOf": [ { "type": "string", "enum": [ "g", "kg", "lb", "oz" ] }, { "type": "null" } ] } }, "required": [ "min", "conditionType" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "amount", "rateType", "currency" ], "additionalProperties": false } }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "groupType", "position", "rates", "variationId" ], "additionalProperties": false } }, "excludeProducts": { "description": "When true, specific products are excluded from price changes. Use excludeProducts when most products should be tested and only a few excluded. Mutually exclusive with includeProducts.", "default": false, "type": "boolean" }, "includeProducts": { "description": "When true, only specific products receive price changes. Use includeProducts when only a few products should be tested. Mutually exclusive with excludeProducts.", "default": false, "type": "boolean" }, "testExperienceId": { "description": "Links to another experience for advanced multi-experience configurations.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "functionSyncError": { "default": false, "description": "Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.", "type": "boolean" }, "redirects": { "description": "URL redirect rules for content/url experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "group": { "type": "number", "description": "Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "originUrl": { "type": "string", "description": "URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field." }, "destinationUrl": { "description": "Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Key-value pairs appended to the destination URL as query parameters.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ], "additionalProperties": false } }, "skip": { "type": "boolean", "description": "When true, this redirect is temporarily disabled." }, "isThemeTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify themes. Used with content/theme experiences." }, "isTemplateTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify templates. Used with content/template experiences." }, "templateType": { "description": "Shopify template type being tested (e.g., product, collection).", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "When true, the redirect fires only once per visitor session to avoid redirect loops.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "id", "group", "variationId", "originUrl", "queryParams", "skip", "isThemeTest", "isTemplateTest", "templateSuffixes", "redirectOnce", "filter", "redirectType" ], "additionalProperties": false } }, "userInterfaces": { "description": "UI widget configurations displayed for this variation.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "isEnabled": { "type": "boolean" }, "isArchived": { "default": false, "type": "boolean" }, "widget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "enabledSitewide": { "default": false, "type": "boolean" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "widgetType": { "type": "string", "enum": [ "messageBoxPopup", "messageBoxSlideOut", "quantityButtons", "discountProgressBar", "shippingProgressBar" ] }, "config": { "type": "object", "properties": { "desktop": {}, "mobile": {} }, "additionalProperties": false } }, "required": [ "id", "name", "enabledSitewide", "widgetType", "config" ], "additionalProperties": false }, "widgetId": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "quantityButtons", "progressBar", "messageBox" ] }, "variationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "desktopVariables": { "anyOf": [ {}, { "type": "null" } ] }, "mobileVariables": { "anyOf": [ {}, { "type": "null" } ] }, "styleOverrides": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "id", "isArchived", "widgetId" ], "additionalProperties": false } }, "checkoutBlocks": { "description": "Shopify checkout extensibility block configurations for this variation.", "default": [], "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "trustBadge" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconSize": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageSize": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 500 }, { "type": "null" } ] }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaSpacing": { "type": "string" } }, "required": [ "order", "type", "imageSize", "imageSizeUnit", "mediaSpacing" ], "additionalProperties": false } } }, "required": [ "headerText", "items" ], "additionalProperties": false, "description": "Configurable content for the trust badge (e.g., badge images, guarantee text)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemSubtitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "itemTitle", "itemSubtitle" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" } }, "required": [ "header", "item", "block" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "itemTitleText": { "type": "string" }, "itemSubtitleText": { "type": "string" } }, "required": [ "headerText", "itemTitleText", "itemSubtitleText" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "rowCount", "columnCount" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "itemBorderThickness": { "type": "string" }, "itemBorderStyle": { "default": "none", "type": "string" }, "itemCornerRadius": { "type": "string" }, "itemTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "itemBorderThickness", "itemBorderStyle", "itemCornerRadius", "itemTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the trust badge appearance." } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "upsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "maxProductLimit": { "default": 3, "type": "integer", "minimum": 1, "maximum": 10 }, "excludeItemsInCart": { "default": false, "type": "boolean" }, "excludeOutOfStock": { "default": false, "type": "boolean" }, "buttonText": { "type": "string" }, "imageSize": { "type": "number", "minimum": 1, "maximum": 500 }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "type": "string" }, "mediaSpacing": { "type": "string" } }, "required": [ "headerText", "maxProductLimit", "excludeItemsInCart", "excludeOutOfStock", "buttonText", "imageSize", "imageSizeUnit", "imageAspectRatio", "mediaSpacing" ], "additionalProperties": false, "description": "Configurable content for the upsell block (e.g., product selection, heading text, CTA label)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "variantTitle": { "default": { "fontSize": "base", "fontStyle": "normal" }, "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "productTitle", "variantTitle", "price", "button" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" }, "button": { "type": "string" }, "productUnit": { "type": "string" } }, "required": [ "header", "item", "block", "button", "productUnit" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "productText": { "type": "string" }, "variantText": { "default": "subdued", "type": "string" }, "priceText": { "type": "string" }, "carouselArrowColor": { "default": "monochrome", "type": "string" }, "carouselArrowStyle": { "default": "primary", "type": "string" } }, "required": [ "headerText", "productText", "variantText", "priceText", "carouselArrowColor", "carouselArrowStyle" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "mobile": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "mobile", "desktop" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "productBorderThickness": { "type": "string" }, "productBorderStyle": { "default": "none", "type": "string" }, "productCornerRadius": { "type": "string" }, "productTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "productBorderThickness", "productBorderStyle", "productCornerRadius", "productTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the upsell block appearance." }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "postPurchaseUpsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "discountType": { "default": "none", "type": "string", "enum": [ "none", "percentage", "fixed" ] }, "discountValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "compareAtPriceDisplay": { "default": "none", "type": "string", "enum": [ "none", "compareAtPrice", "regularPrice" ] }, "imageAspectRatio": { "type": "string" }, "excludeOutOfStock": { "type": "boolean" }, "excludeItemsInCart": { "type": "boolean" }, "maxProductLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bannerEnabled": { "type": "boolean" }, "bannerTitle": { "type": "string" }, "bannerSubtitle": { "type": "string" }, "compareAtPriceEnabled": { "type": "boolean" }, "descriptionEnabled": { "type": "boolean" }, "quantitySelectorEnabled": { "type": "boolean" }, "quantityLabel": { "type": "string" }, "maxQuantityType": { "type": "string" }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "moneyLineEnabled": { "type": "boolean" }, "moneyLineSubtotal": { "type": "boolean" }, "moneyLineShipping": { "type": "boolean" }, "moneyLineTaxes": { "type": "boolean" }, "primaryButtonText": { "type": "string" }, "secondaryButtonEnabled": { "type": "boolean" }, "secondaryButtonText": { "type": "string" }, "headingLevel": { "type": "string" } }, "required": [ "headerText", "discountType", "compareAtPriceDisplay", "imageAspectRatio", "excludeOutOfStock", "excludeItemsInCart", "maxProductLimit", "bannerEnabled", "compareAtPriceEnabled", "descriptionEnabled", "quantitySelectorEnabled", "moneyLineEnabled", "moneyLineSubtotal", "moneyLineShipping", "moneyLineTaxes", "primaryButtonText", "secondaryButtonEnabled", "headingLevel" ], "additionalProperties": false }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "description": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "primaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "secondaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "productTitle", "price", "primaryButton" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "banner": { "type": "string" }, "primaryButton": { "type": "string" }, "secondaryButton": { "type": "string" } }, "required": [ "banner", "primaryButton" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "bannerText": { "type": "string" }, "productText": { "type": "string" }, "priceText": { "type": "string" }, "descriptionText": { "type": "string" }, "primaryButtonText": { "type": "string" }, "secondaryButtonText": { "type": "string" } }, "required": [ "productText", "priceText", "primaryButtonText" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "bannerBorderStyle": { "type": "string" }, "bannerSpacing": { "type": "string" }, "bannerTextAlign": { "type": "string" }, "separatorWidth": { "type": "string" }, "imageFit": { "type": "string" }, "imageBorder": { "type": "boolean" }, "pricingAppearance": { "type": "string" }, "pricingEmphasized": { "type": "boolean" }, "pricingSubduedStyle": { "type": "boolean" }, "descriptionSubdued": { "type": "boolean" }, "secondaryButtonStyle": { "type": "string" } }, "required": [ "bannerBorderStyle", "bannerSpacing", "bannerTextAlign", "separatorWidth", "imageFit", "imageBorder", "pricingEmphasized", "descriptionSubdued", "secondaryButtonStyle" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "appearance" ], "additionalProperties": false }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false } ], "type": "object" } }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false } } }, "required": [ "id", "experienceId", "name", "percentage", "isControl", "order", "onsiteEdits", "functionSyncError" ], "additionalProperties": false } }, "graphs": { "description": "Pre-rendered graph images. Only included when graphs are requested. When graphOutput is 'base64', each graph includes a 'data' field with the base64-encoded PNG. Otherwise, each graph includes a 'url' field with the image URL (expires after 30 days).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "description": "The original graph key from the query parameter (e.g., 'conversion_rate', 'net_revenue_per_visitor').", "type": "string" }, "url": { "description": "URL of the rendered graph image. Included when graphOutput is 'png' (default). Expires after 30 days \u2014 download and store externally if you need to retain it longer.", "type": "string" }, "data": { "description": "Base64-encoded PNG image data. Included when graphOutput is 'base64'.", "type": "string" }, "type": { "type": "string", "description": "Chart type for the rendered graph (e.g. 'bar')." }, "title": { "type": "string", "description": "Display title of the rendered graph." } }, "required": [ "id", "type", "title" ], "additionalProperties": false } }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "experienceName": { "type": "string" }, "downsample": { "type": "object", "properties": { "from": { "type": "string", "enum": [ "HOUR", "DAY", "WEEK" ] }, "to": { "type": "string", "enum": [ "HOUR", "DAY", "WEEK" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "impact": { "type": "object", "properties": { "est_monthly_revenue_increase": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Estimated monthly revenue increase for the best-performing non-control variation compared to the control, extrapolated to a 30-day period. Calculated as: Math.round((treatment_rpv - control_rpv) * total_visitors * (30 / test_days)), where rpv is net_revenue_per_visitor. Null when insufficient data is available." } }, "required": [ "est_monthly_revenue_increase" ], "additionalProperties": false } }, "required": [ "datasetId", "latestRunTs", "metrics", "audienceOrder", "histogram", "kde", "cdf" ], "additionalProperties": false } } } } } }, "post": { "tags": [ "Fetch Experience Data" ], "description": "Analyze analytics data for a specific experience using a POST request body for filters and request settings.\n\nThe legacy `GET /analytics/resource/{experienceId}` endpoint remains available only as a beta compatibility path for existing integrations. It is deprecated, limited to its original query-parameter contract, and will be removed when the beta version ends.\n\nValid `view` values are `overview` and `audience`. The value `summary` is not supported. When `view` is `audience`, you must also provide the `audience` field.\n\nUse `startTs` and `endTs` in the request body to match the backend contract. These values must be 10-digit Unix epoch timestamps in seconds, not milliseconds. Use the `filters` object for all advanced filtering instead of query parameters.\n\n### Graphs\n\nWhen requesting graphs via the `graphs` object, `graphs.ids` accepts an array of metric identifiers. Valid values are: `conversion_rate`, `add_to_cart_rate`, `abandoned_cart_rate`, `abandoned_checkout_rate`, `checkout_begin_rate`, `checkout_enter_contact_info_rate`, `checkout_address_submitted_rate`, `view_product_page_rate`, `view_collection_page_rate`, `net_revenue_per_visitor`, `net_product_revenue_per_order`, `net_revenue_per_order`, `avg_units_per_order`, `avg_product_revenue_per_unit`, `profit_per_visitor`, `profit_per_order`, `pct_orders_free_shipping`, `net_shipping_revenue_per_order`, `subscription_orders_per_visitor`, `subscription_revenue_per_visitor`, `subscription_profit_per_visitor`, `subscription_product_revenue_per_order`, `avg_discount_per_discounted_order`, `avg_discount_per_all_orders`, `pct_subscription_orders`, `subscription_revenue_per_order`.\n\nNote: `revenue_per_visitor` is **not** a valid graph ID \u2014 use `net_revenue_per_visitor` instead.\n\nEach graph object in the response includes `id` (string), `key` (the original metric key), `type` (chart type, e.g. `\"bar\"`), `title` (display title), and either `url` (CDN URL when `outputFormat` is `\"png\"`) or `data` (base64-encoded PNG when `outputFormat` is `\"base64\"`).\n\n### Additional Response Fields\n\nResponse payloads include `impact` (object with `est_monthly_revenue_increase`: the projected 30-day revenue lift from the best non-control variation vs. control, or `null` when there is insufficient data) plus distribution and ordering helpers: `audienceOrder` (segment display ordering when using audience view), `histogram` (order value distribution bins), `kde` (kernel density estimate curve), and `cdf` (cumulative distribution function curve). These are present alongside the primary `metrics` and `variations` arrays.", "security": [ { "intelligems_access_token": [] } ], "x-codeSamples": [ { "lang": "Shell", "label": "Overview with date range + specific graph images", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"startTs\": \"1764199800\",\n \"endTs\": \"1764223200\",\n \"graphs\": {\n \"ids\": [\"conversion_rate\", \"net_revenue_per_visitor\", \"add_to_cart_rate\"],\n \"outputFormat\": \"png\"\n }\n}'" }, { "lang": "Shell", "label": "Audience breakdown by device type", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"view\": \"audience\",\n \"audience\": \"device_type\"\n}'" }, { "lang": "Shell", "label": "Filter by device type and country", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"startTs\": \"1764199800\",\n \"endTs\": \"1764223200\",\n \"filters\": {\n \"deviceType\": \"mobile\",\n \"countryCodes\": [\"US\", \"CA\"]\n }\n}'" }, { "lang": "Shell", "label": "Filter by traffic source and landing page", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"startTs\": \"1764199800\",\n \"endTs\": \"1764223200\",\n \"filters\": {\n \"sourceSitesOrChannels\": [\"Paid Search\", \"Email\"],\n \"landingPage\": {\n \"landingPageUrlPath\": \"/collections/sale\",\n \"landingPageUrlPathFilterType\": \"startsWith\"\n }\n }\n}'" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "default": "overview", "description": "Resource view to analyze. Supported values are 'overview' for variation-level metrics and 'audience' for a breakdown by the selected audience dimension.", "type": "string", "enum": [ "overview", "audience" ] }, "audience": { "description": "Audience breakdown dimension returned when `view` is `audience`. This field is required when `view` is `audience`. Use one of the supported audience fields such as `device_type`, `visitor_type`, or `source_channel`.", "type": "string", "enum": [ "device_type", "visitor_type", "source_channel", "source_site", "country_code", "landing_page_full_path" ] }, "analyticsViewType": { "description": "Optional analytics view preset used by the backend when building the analysis request.", "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ] }, "endTs": { "description": "Optional analysis end timestamp as a 10-digit Unix epoch string in seconds (not milliseconds). Maps directly to the backend `endTs` field.", "type": "string" }, "startTs": { "description": "Optional analysis start timestamp as a 10-digit Unix epoch string in seconds (not milliseconds). Maps directly to the backend `startTs` field.", "type": "string" }, "graphs": { "type": "object", "properties": { "ids": { "description": "Array of graph IDs to render in the response.", "type": "array", "items": { "type": "string", "enum": [ "conversion_rate", "add_to_cart_rate", "abandoned_cart_rate", "abandoned_checkout_rate", "checkout_begin_rate", "checkout_enter_contact_info_rate", "checkout_address_submitted_rate", "view_product_page_rate", "view_collection_page_rate", "net_revenue_per_visitor", "net_revenue_per_order", "net_product_revenue_per_order", "net_shipping_revenue_per_order", "avg_units_per_order", "avg_product_revenue_per_unit", "profit_per_visitor", "subscription_product_revenue_per_order", "subscription_revenue_per_order", "subscription_orders_per_visitor", "subscription_revenue_per_visitor", "subscription_profit_per_visitor", "profit_per_order", "pct_orders_free_shipping", "avg_discount_per_discounted_order", "avg_discount_per_all_orders", "pct_subscription_orders" ] } }, "outputFormat": { "description": "Graph output format. Use `png` for signed image URLs or `base64` to inline the PNG data in the response.", "type": "string", "enum": [ "png", "base64" ] } } }, "filters": { "description": "Structured analytics filters object for `POST /analytics/resource/{experienceId}`. This replaces the deprecated GET endpoint's query-parameter filter pattern and supports device, visitor, traffic source, URL, user behavior, revenue, custom event, product, and targeting filters.\n\nAnalytics filters object for narrowing experience/experiment result data.", "type": "object", "properties": { "deviceType": { "description": "Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.", "anyOf": [ { "type": "string", "enum": [ "any", "mobile", "desktop" ] }, { "type": "null" } ] }, "visitorType": { "description": "Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.", "anyOf": [ { "type": "string", "enum": [ "any", "new", "returning" ] }, { "type": "null" } ] }, "sourceSitesOrChannels": { "description": "Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.", "type": "array", "items": { "type": "string", "enum": [ "Referral", "All Social", "Organic Social", "Paid Social", "Organic Search", "Paid Search", "Paid Shopping", "Email", "Google", "Facebook", "Instagram", "Linktree", "TikTok", "Twitter", "Direct", "SMS", "Other", "Meta", "Link Tree", "Wunderkind Text", "Youtube", "any" ] } }, "urlParam": { "description": "Filter by URL query parameter. Object with: queryParam (string|null \u2014 the parameter name), queryParamValue (string|null \u2014 the value to match), queryParamFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull', 'regex'). For 'isNull'/'isNotNull' operators, set queryParamValue to null.", "type": "object", "properties": { "queryParam": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParamValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParamFilterType": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] } }, "required": [ "queryParam", "queryParamValue", "queryParamFilterType" ] }, "landingPage": { "description": "Filter by landing page URL path. Object with: landingPageUrlPath (string|null \u2014 the path to match), landingPageUrlPathFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull'). For 'isNull'/'isNotNull' operators, set landingPageUrlPath to null. Note: 'regex' is NOT supported here (unlike urlParam).", "anyOf": [ { "type": "object", "properties": { "landingPageUrlPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "landingPageUrlPathFilterType": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] }, { "type": "null" } ] } }, "required": [ "landingPageUrlPath", "landingPageUrlPathFilterType" ] }, { "type": "null" } ] }, "landingPageFilters": { "description": "Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against \u2014 omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.", "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] } }, "required": [ "filterType" ] } }, "landingPageFiltersOperator": { "description": "How multiple items in landingPageFilters are combined. 'or' (default) \u2014 session matches if any filter item matches. 'and' \u2014 session must match every filter item.", "type": "string", "enum": [ "or", "and" ] }, "userBehavior": { "description": "Filter by visitor browsing behavior. Object with optional boolean flags: viewedCheckout, addedToCart, viewedProductPage, viewedCollectionPage. Set a flag to true to include only visitors who performed that action. Omit or null for flags you don't want to filter on. Multiple true flags are combined with AND logic.", "type": "object", "properties": { "viewedCheckout": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "addedToCart": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "viewedProductPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "viewedCollectionPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } } }, "countryCodes": { "description": "Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.", "type": "array", "items": { "type": "string" } }, "maxZScore": { "description": "Maximum Z-score threshold for outlier filtering on order revenue. Visitors with orders whose Z-score exceeds this value are excluded. Accepts number or numeric string. Null or omit to disable outlier filtering.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "triggeredCustomEvents": { "description": "Filter by custom event identifiers that visitors must have triggered. Requires customEventsFilterType to be set to control matching logic. Has no effect without customEventsFilterType. Pull this field from the GET https://api.intelligems.io/v25-10-beta/experiences endpoint > experienceCustomMetrics > customEvent > identifier field.", "type": "array", "items": { "type": "string" } }, "customEventsFilterType": { "description": "How triggeredCustomEvents should be matched: 'any' (visitor triggered at least one), 'all' (visitor triggered every listed event), 'none' (visitor triggered none of the listed events). Requires triggeredCustomEvents to be a non-empty array.", "type": "string", "enum": [ "any", "all", "none" ] }, "reachedCheckoutStage": { "description": "Filter by checkout funnel stage reached. Options: 'any' (visitor reached ANY checkout stage \u2014 this IS an active filter, unlike 'any' in deviceType/visitorType), 'started' (began checkout), 'contact_info_submitted', 'address_info_submitted', 'added_to_cart'. Omit or null to not filter by checkout stage.", "anyOf": [ { "type": "string", "enum": [ "started", "contact_info_submitted", "address_info_submitted", "any", "added_to_cart" ] }, { "type": "null" } ] }, "conversionFunnel": { "description": "Filter by sitewide conversion funnel stage", "type": "object", "properties": { "abandonedCart": { "type": "boolean" }, "abandonedCheckout": { "type": "boolean" }, "addedToCart": { "type": "boolean" }, "bounced": { "type": "boolean" }, "converted": { "type": "boolean" }, "exitedBeforeAtc": { "type": "boolean" }, "startedCheckout": { "type": "boolean" }, "viewedCollectionPage": { "type": "boolean" }, "viewedProductPage": { "type": "boolean" }, "landingPageType": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] }, "secondPageType": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] } } }, "minNetRevenue": { "description": "Minimum order net revenue to include (inclusive). Accepts number or numeric string. Omit or null to not apply a minimum.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "maxNetRevenue": { "description": "Maximum order net revenue to include (inclusive). Accepts number or numeric string. Omit or null to not apply a maximum.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "minShippingRevenue": { "description": "Minimum shipping revenue to include (inclusive). Accepts number or numeric string. Omit or null to not apply a minimum.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "maxShippingRevenue": { "description": "Maximum shipping revenue to include (inclusive). Accepts number or numeric string. Omit or null to not apply a maximum.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "shippingMethods": { "description": "Filter by shipping method names. Only orders using one of these methods are included.", "type": "array", "items": { "type": "string" } }, "landingPageTypes": { "description": "Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.", "type": "array", "items": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] } }, "allOrders": { "description": "Whether to include all orders or only matched orders.", "type": "boolean" }, "experimentProductsOnly": { "description": "When true, only include products that are part of the experiment. Only applies when analyzing an experience/experiment.", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "onlyProductIds": { "description": "Filter to only include specific Shopify product IDs (numeric strings).", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "onlyProductHandles": { "description": "Filter to only include specific Shopify product handles.", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } } } } } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string", "enum": [ "order_line_items", "orders", "aiProfit", "variation_overview", "variation_audience", "variation_timeseries_discrete", "variation_timeseries_cumulative", "experience_countries", "variation_shipping_method", "variation_histogram", "variation_products", "variation_product_groups", "variation_order_unit_mix", "custom_events_plugin", "custom_events_server", "order_reconciliation", "order_reconciliation_export", "timeseries", "country_codes", "snapshots", "experience_shipping_methods", "timeseries_audience", "snapshots_audience", "holiday_benchmarking_single_day", "holiday_benchmarking_multiple_days", "order_distribution_histogram", "order_distribution_unit_mix", "conversion_snapshots", "conversion_funnel", "conversion_timeseries", "variation_post_metrics", "variation_post_metrics_audience" ] }, "latestRunTs": { "type": "number" }, "metrics": { "type": "array", "items": {}, "description": "Array of metric objects. Each metric object may contain the following fields (all optional):\n \n **Dimension Fields:**\n - variation_id (string, UUID): The variation identifier\n - dt (string): Timestamp for time series data\n - audience (string): Audience segment identifier\n \n **Metric Fields (alphabetical):**\n - abandoned_cart_rate: Rate of abandoned carts\n - abandoned_checkout_rate: Rate of abandoned checkouts\n - add_to_cart_rate: Add to cart rate\n - avg_discount_per_all_orders: Average discount amount across all orders\n - avg_discount_per_discounted_order: Average discount amount for orders with discounts\n - avg_product_revenue_per_unit: Average revenue per product unit\n - avg_units_per_order: Average number of units per order\n - checkout_address_submitted_rate: Rate of checkouts with address submitted\n - checkout_begin_rate: Checkout initiation rate\n - checkout_enter_contact_info_rate: Rate of checkouts with contact info entered\n - conversion_rate: Conversion rate metric with statistical details\n - gross_profit_per_order: Gross profit per order\n - gross_profit_per_visitor: Gross profit per visitor\n - n_orders: Number of orders\n - n_visitors: Number of visitors\n - net_product_revenue_per_order: Average product revenue per order\n - net_revenue: Total net revenue\n - net_revenue_per_order: Average revenue per order\n - net_revenue_per_visitor: Average revenue per visitor\n - net_shipping_revenue_per_order: Average shipping revenue per order\n - pct_orders_free_shipping: Percentage of orders with free shipping\n - pct_subscription_orders: Percentage of orders that are subscriptions\n - subscription_gross_profit_per_visitor: Gross profit from subscriptions per visitor\n - subscription_orders_per_visitor: Subscription orders per visitor\n - subscription_revenue_per_order: Revenue from subscriptions per order\n - subscription_revenue_per_visitor: Revenue from subscriptions per visitor\n - view_collection_page_rate: Collection page view rate\n - view_product_page_rate: Product page view rate\n \n Each statistical metric contains:\n - value (number): The metric value" }, "audienceOrder": {}, "histogram": {}, "kde": {}, "cdf": {}, "variations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "name": { "type": "string", "description": "Display name (e.g., 'Control', 'Variant A'). Unique within the experience." }, "percentage": { "type": "number", "description": "Traffic allocation weight. All percentages across sibling variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order in the analytics dashboard. 0-indexed." }, "priceChange": { "description": "Price adjustment amount for pricing-type experiences. Positive increases price, negative discounts. Use priceChange for simple price A/B tests; use offer for structured discount campaigns (tiered, BOGO, free shipping).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priceChangeUnit": { "description": "How priceChange is applied: as a percentage of the original price or a fixed monetary amount.", "anyOf": [ { "type": "string", "enum": [ "percent", "dollar" ] }, { "type": "null" } ] }, "priceRoundingType": { "description": "Rounding strategy applied after priceChange (e.g., round up, round down, charm pricing).", "anyOf": [ { "type": "string", "enum": [ "none", "nearest", "up", "down" ] }, { "type": "null" } ] }, "priceRoundingAmount": { "description": "Target value for rounding (e.g., 0.99 for charm pricing like $X.99).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onsiteEdits": { "default": [], "description": "DOM content modifications (text, HTML, image swaps, element removal). For CSS styling changes, use onsiteInjections instead.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "onsiteEditType": { "description": "Content modification strategy (html, text, image, or hide).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to locate on the page. Interpreted as regex when isRegex is true." }, "title": { "description": "Dashboard label for identifying this edit.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "When true, 'find' is treated as a regular expression.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content. Interpretation depends on onsiteEditType: HTML markup, plain text, or image URL.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping which DOM elements this edit targets (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "When true, this edit is temporarily disabled without being deleted.", "type": "boolean" }, "remove": { "default": false, "description": "When true, the matched element is removed from the DOM instead of having its content replaced.", "type": "boolean" }, "groupId": { "description": "Groups related edits together so they can be managed as a unit.", "type": "string" }, "isHtml": { "default": false, "type": "boolean" }, "isImage": { "default": false, "type": "boolean" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to the target (beforebegin, afterbegin, beforeend, afterend). Null means content replacement." }, "createdAtUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Server-generated. Read-only. Storefront URL where this edit was originally created via the visual editor." }, "createdAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname for locating images to replace. When set, images are found by URL match; when null, querySelectors is used instead." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "find", "isRegex", "replace", "querySelectors", "skip", "remove", "isHtml", "isImage", "insertType" ], "additionalProperties": false } }, "onsiteInjections": { "description": "CSS styling and custom JS injection. At most one per variation. For DOM content changes (text, images, HTML), use onsiteEdits instead.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "type" ], "additionalProperties": false, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "jsInjectionMode" ], "additionalProperties": false }, { "type": "null" } ] }, "offer": { "description": "Structured discount configuration (tiered volume discounts, cart-level discounts, gift-with-purchase, free shipping). Use offer for campaign/discount experiences; use priceChange for simple price A/B tests.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation this offer belongs to." }, "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "description": "Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "minimumUnits": { "default": 1, "type": "number" }, "maximumUnits": { "default": 1, "type": "number" }, "unitDiscount": { "default": 1, "type": "number" }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "minimumUnits", "maximumUnits", "unitDiscount", "discountTitle", "giftWithPurchaseTitle", "isFreeShipping", "isGiftWithPurchase", "autoAddGiftWithPurchase" ], "additionalProperties": false } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ], "additionalProperties": false } } }, "required": [ "type", "rules" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ], "additionalProperties": false }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] } }, "required": [ "id", "variationId", "enabled", "isTest", "isArchived", "name", "unitType", "discountType", "tiers", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount", "requireSameItem", "subscriptionApplicationType" ], "additionalProperties": false }, { "type": "null" } ] }, "offerId": { "description": "Server-generated. Read-only. References the associated offer. Populated when offer is set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "shippingRateGroups": { "description": "Shipping rate overrides. Only populated for shipping test experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupType": { "type": "string", "enum": [ "flatRate", "flatRateWithThreshold", "thresholdOnly", "tieredByPriceOrWeight", "custom" ] }, "position": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "amount": { "type": "number" }, "rateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rateType": { "type": "string", "enum": [ "amount", "threshold", "tier" ] }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SRD", "STD", "SZL", "THB", "TJS", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "min": { "default": 0, "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "conditionType": { "type": "string", "enum": [ "currency", "weight" ] }, "unit": { "anyOf": [ { "type": "string", "enum": [ "g", "kg", "lb", "oz" ] }, { "type": "null" } ] } }, "required": [ "min", "conditionType" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "amount", "rateType", "currency" ], "additionalProperties": false } }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "groupType", "position", "rates", "variationId" ], "additionalProperties": false } }, "excludeProducts": { "description": "When true, specific products are excluded from price changes. Use excludeProducts when most products should be tested and only a few excluded. Mutually exclusive with includeProducts.", "default": false, "type": "boolean" }, "includeProducts": { "description": "When true, only specific products receive price changes. Use includeProducts when only a few products should be tested. Mutually exclusive with excludeProducts.", "default": false, "type": "boolean" }, "testExperienceId": { "description": "Links to another experience for advanced multi-experience configurations.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "functionSyncError": { "default": false, "description": "Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.", "type": "boolean" }, "redirects": { "description": "URL redirect rules for content/url experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "group": { "type": "number", "description": "Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "originUrl": { "type": "string", "description": "URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field." }, "destinationUrl": { "description": "Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Key-value pairs appended to the destination URL as query parameters.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ], "additionalProperties": false } }, "skip": { "type": "boolean", "description": "When true, this redirect is temporarily disabled." }, "isThemeTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify themes. Used with content/theme experiences." }, "isTemplateTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify templates. Used with content/template experiences." }, "templateType": { "description": "Shopify template type being tested (e.g., product, collection).", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "When true, the redirect fires only once per visitor session to avoid redirect loops.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "id", "group", "variationId", "originUrl", "queryParams", "skip", "isThemeTest", "isTemplateTest", "templateSuffixes", "redirectOnce", "filter", "redirectType" ], "additionalProperties": false } }, "userInterfaces": { "description": "UI widget configurations displayed for this variation.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "isEnabled": { "type": "boolean" }, "isArchived": { "default": false, "type": "boolean" }, "widget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "enabledSitewide": { "default": false, "type": "boolean" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "widgetType": { "type": "string", "enum": [ "messageBoxPopup", "messageBoxSlideOut", "quantityButtons", "discountProgressBar", "shippingProgressBar" ] }, "config": { "type": "object", "properties": { "desktop": {}, "mobile": {} }, "additionalProperties": false } }, "required": [ "id", "name", "enabledSitewide", "widgetType", "config" ], "additionalProperties": false }, "widgetId": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "quantityButtons", "progressBar", "messageBox" ] }, "variationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "desktopVariables": { "anyOf": [ {}, { "type": "null" } ] }, "mobileVariables": { "anyOf": [ {}, { "type": "null" } ] }, "styleOverrides": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "id", "isArchived", "widgetId" ], "additionalProperties": false } }, "checkoutBlocks": { "description": "Shopify checkout extensibility block configurations for this variation.", "default": [], "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "trustBadge" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconSize": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageSize": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 500 }, { "type": "null" } ] }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaSpacing": { "type": "string" } }, "required": [ "order", "type", "imageSize", "imageSizeUnit", "mediaSpacing" ], "additionalProperties": false } } }, "required": [ "headerText", "items" ], "additionalProperties": false, "description": "Configurable content for the trust badge (e.g., badge images, guarantee text)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemSubtitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "itemTitle", "itemSubtitle" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" } }, "required": [ "header", "item", "block" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "itemTitleText": { "type": "string" }, "itemSubtitleText": { "type": "string" } }, "required": [ "headerText", "itemTitleText", "itemSubtitleText" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "rowCount", "columnCount" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "itemBorderThickness": { "type": "string" }, "itemBorderStyle": { "default": "none", "type": "string" }, "itemCornerRadius": { "type": "string" }, "itemTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "itemBorderThickness", "itemBorderStyle", "itemCornerRadius", "itemTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the trust badge appearance." } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "upsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "maxProductLimit": { "default": 3, "type": "integer", "minimum": 1, "maximum": 10 }, "excludeItemsInCart": { "default": false, "type": "boolean" }, "excludeOutOfStock": { "default": false, "type": "boolean" }, "buttonText": { "type": "string" }, "imageSize": { "type": "number", "minimum": 1, "maximum": 500 }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "type": "string" }, "mediaSpacing": { "type": "string" } }, "required": [ "headerText", "maxProductLimit", "excludeItemsInCart", "excludeOutOfStock", "buttonText", "imageSize", "imageSizeUnit", "imageAspectRatio", "mediaSpacing" ], "additionalProperties": false, "description": "Configurable content for the upsell block (e.g., product selection, heading text, CTA label)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "variantTitle": { "default": { "fontSize": "base", "fontStyle": "normal" }, "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "productTitle", "variantTitle", "price", "button" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" }, "button": { "type": "string" }, "productUnit": { "type": "string" } }, "required": [ "header", "item", "block", "button", "productUnit" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "productText": { "type": "string" }, "variantText": { "default": "subdued", "type": "string" }, "priceText": { "type": "string" }, "carouselArrowColor": { "default": "monochrome", "type": "string" }, "carouselArrowStyle": { "default": "primary", "type": "string" } }, "required": [ "headerText", "productText", "variantText", "priceText", "carouselArrowColor", "carouselArrowStyle" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "mobile": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "mobile", "desktop" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "productBorderThickness": { "type": "string" }, "productBorderStyle": { "default": "none", "type": "string" }, "productCornerRadius": { "type": "string" }, "productTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "productBorderThickness", "productBorderStyle", "productCornerRadius", "productTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the upsell block appearance." }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "postPurchaseUpsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "discountType": { "default": "none", "type": "string", "enum": [ "none", "percentage", "fixed" ] }, "discountValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "compareAtPriceDisplay": { "default": "none", "type": "string", "enum": [ "none", "compareAtPrice", "regularPrice" ] }, "imageAspectRatio": { "type": "string" }, "excludeOutOfStock": { "type": "boolean" }, "excludeItemsInCart": { "type": "boolean" }, "maxProductLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bannerEnabled": { "type": "boolean" }, "bannerTitle": { "type": "string" }, "bannerSubtitle": { "type": "string" }, "compareAtPriceEnabled": { "type": "boolean" }, "descriptionEnabled": { "type": "boolean" }, "quantitySelectorEnabled": { "type": "boolean" }, "quantityLabel": { "type": "string" }, "maxQuantityType": { "type": "string" }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "moneyLineEnabled": { "type": "boolean" }, "moneyLineSubtotal": { "type": "boolean" }, "moneyLineShipping": { "type": "boolean" }, "moneyLineTaxes": { "type": "boolean" }, "primaryButtonText": { "type": "string" }, "secondaryButtonEnabled": { "type": "boolean" }, "secondaryButtonText": { "type": "string" }, "headingLevel": { "type": "string" } }, "required": [ "headerText", "discountType", "compareAtPriceDisplay", "imageAspectRatio", "excludeOutOfStock", "excludeItemsInCart", "maxProductLimit", "bannerEnabled", "compareAtPriceEnabled", "descriptionEnabled", "quantitySelectorEnabled", "moneyLineEnabled", "moneyLineSubtotal", "moneyLineShipping", "moneyLineTaxes", "primaryButtonText", "secondaryButtonEnabled", "headingLevel" ], "additionalProperties": false }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "description": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "primaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "secondaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "productTitle", "price", "primaryButton" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "banner": { "type": "string" }, "primaryButton": { "type": "string" }, "secondaryButton": { "type": "string" } }, "required": [ "banner", "primaryButton" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "bannerText": { "type": "string" }, "productText": { "type": "string" }, "priceText": { "type": "string" }, "descriptionText": { "type": "string" }, "primaryButtonText": { "type": "string" }, "secondaryButtonText": { "type": "string" } }, "required": [ "productText", "priceText", "primaryButtonText" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "bannerBorderStyle": { "type": "string" }, "bannerSpacing": { "type": "string" }, "bannerTextAlign": { "type": "string" }, "separatorWidth": { "type": "string" }, "imageFit": { "type": "string" }, "imageBorder": { "type": "boolean" }, "pricingAppearance": { "type": "string" }, "pricingEmphasized": { "type": "boolean" }, "pricingSubduedStyle": { "type": "boolean" }, "descriptionSubdued": { "type": "boolean" }, "secondaryButtonStyle": { "type": "string" } }, "required": [ "bannerBorderStyle", "bannerSpacing", "bannerTextAlign", "separatorWidth", "imageFit", "imageBorder", "pricingEmphasized", "descriptionSubdued", "secondaryButtonStyle" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "appearance" ], "additionalProperties": false }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false } ], "type": "object" } }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false } } }, "required": [ "id", "experienceId", "name", "percentage", "isControl", "order", "onsiteEdits", "functionSyncError" ], "additionalProperties": false } }, "graphs": { "description": "Pre-rendered graph images. Only included when graphs are requested. When graphOutput is 'base64', each graph includes a 'data' field with the base64-encoded PNG. Otherwise, each graph includes a 'url' field with the image URL (expires after 30 days).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "description": "The original graph key from the query parameter (e.g., 'conversion_rate', 'net_revenue_per_visitor').", "type": "string" }, "url": { "description": "URL of the rendered graph image. Included when graphOutput is 'png' (default). Expires after 30 days \u2014 download and store externally if you need to retain it longer.", "type": "string" }, "data": { "description": "Base64-encoded PNG image data. Included when graphOutput is 'base64'.", "type": "string" }, "type": { "type": "string", "description": "Chart type for the rendered graph (e.g. 'bar')." }, "title": { "type": "string", "description": "Display title of the rendered graph." } }, "required": [ "id", "type", "title" ], "additionalProperties": false } }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "experienceName": { "type": "string" }, "downsample": { "type": "object", "properties": { "from": { "type": "string", "enum": [ "HOUR", "DAY", "WEEK" ] }, "to": { "type": "string", "enum": [ "HOUR", "DAY", "WEEK" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "impact": { "type": "object", "properties": { "est_monthly_revenue_increase": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Estimated monthly revenue increase for the best-performing non-control variation compared to the control, extrapolated to a 30-day period. Calculated as: Math.round((treatment_rpv - control_rpv) * total_visitors * (30 / test_days)), where rpv is net_revenue_per_visitor. Null when insufficient data is available." } }, "required": [ "est_monthly_revenue_increase" ], "additionalProperties": false } }, "required": [ "datasetId", "latestRunTs", "metrics", "audienceOrder", "histogram", "kde", "cdf" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/analytics/sitewide/order-distribution": { "post": { "tags": [ "Fetch Sitewide Analytics" ], "description": "Retrieve order value distribution data and unit mix breakdowns for a time window.\n\nThe response returns `orderValueDistribution.kernel_density_estimate` and `orderValueDistribution.cumulative_distribution_function`, plus `orderBreakdown`.", "security": [ { "intelligems_access_token": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "description": "Start of analysis period as an ISO 8601 datetime string (e.g. '2025-01-01T00:00:00.000-05:00'). Defaults to 30 days ago.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "end": { "description": "End of analysis period as an ISO 8601 datetime string. Defaults to now.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "filters": { "description": "Optional analytics filters object. See the Filters Reference for available filter fields.", "type": "object", "properties": { "deviceType": { "description": "Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.", "anyOf": [ { "type": "string", "enum": [ "any", "mobile", "desktop" ] }, { "type": "null" } ] }, "visitorType": { "description": "Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.", "anyOf": [ { "type": "string", "enum": [ "any", "new", "returning" ] }, { "type": "null" } ] }, "sourceSitesOrChannels": { "description": "Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.", "type": "array", "items": { "type": "string", "enum": [ "Referral", "All Social", "Organic Social", "Paid Social", "Organic Search", "Paid Search", "Paid Shopping", "Email", "Google", "Facebook", "Instagram", "Linktree", "TikTok", "Twitter", "Direct", "SMS", "Other", "Meta", "Link Tree", "Wunderkind Text", "Youtube", "any" ] } }, "landingPage": { "description": "Filter by landing page URL path. Object with: landingPageUrlPath (string|null \u2014 the path to match), landingPageUrlPathFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull'). For 'isNull'/'isNotNull' operators, set landingPageUrlPath to null. Note: 'regex' is NOT supported here (unlike urlParam).", "anyOf": [ { "type": "object", "properties": { "landingPageUrlPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "landingPageUrlPathFilterType": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] }, { "type": "null" } ] } }, "required": [ "landingPageUrlPath", "landingPageUrlPathFilterType" ] }, { "type": "null" } ] }, "landingPageFilters": { "description": "Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against \u2014 omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.", "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] } }, "required": [ "filterType" ] } }, "landingPageFiltersOperator": { "description": "How multiple items in landingPageFilters are combined. 'or' (default) \u2014 session matches if any filter item matches. 'and' \u2014 session must match every filter item.", "type": "string", "enum": [ "or", "and" ] }, "countryCodes": { "description": "Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.", "type": "array", "items": { "type": "string" } }, "maxZScore": { "description": "Maximum Z-score threshold for outlier filtering on order revenue. Visitors with orders whose Z-score exceeds this value are excluded. Accepts number or numeric string. Null or omit to disable outlier filtering.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "landingPageTypes": { "description": "Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.", "type": "array", "items": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] } }, "allOrders": { "description": "Whether to include all orders or only matched orders.", "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code for monetary values (e.g. 'USD')." }, "orderValueDistribution": { "type": "object", "properties": { "kernel_density_estimate": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "number" }, "current_period": { "type": "number" }, "previous_period": { "type": "number" } }, "required": [ "x", "current_period", "previous_period" ], "additionalProperties": false }, "description": "Kernel density estimation curve points for order value distribution. Each point has an `x` (order value), `current_period`, and `previous_period` field." }, "cumulative_distribution_function": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "number" }, "current_period": { "type": "number" }, "previous_period": { "type": "number" } }, "required": [ "x", "current_period", "previous_period" ], "additionalProperties": false }, "description": "Cumulative distribution function curve points for order value distribution. Each point has an `x` (order value), `current_period`, and `previous_period` field." } }, "required": [ "kernel_density_estimate", "cumulative_distribution_function" ], "additionalProperties": false, "description": "Order value distribution object containing `kernel_density_estimate` and `cumulative_distribution_function` arrays. Each point has an `x` (order value), `current_period`, and `previous_period` field." }, "orderBreakdown": { "type": "array", "items": { "type": "object", "properties": { "unit_quantity": { "type": "number" }, "n_orders": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "value" ], "additionalProperties": false }, "net_revenue": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "value" ], "additionalProperties": false }, "gross_profit": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "value" ], "additionalProperties": false }, "pct_orders_by_unit_quantity": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "value" ], "additionalProperties": false }, "pct_revenue_by_unit_quantity": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "value" ], "additionalProperties": false }, "pct_profit_by_unit_quantity": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "value" ], "additionalProperties": false } }, "required": [ "unit_quantity", "n_orders", "net_revenue", "gross_profit", "pct_orders_by_unit_quantity", "pct_revenue_by_unit_quantity", "pct_profit_by_unit_quantity" ], "additionalProperties": false }, "description": "Breakdown of orders, revenue, and profit by number of units per order. Each entry has unit_quantity and metric values (n_orders, net_revenue, gross_profit as value objects, plus percentage equivalents)." } }, "required": [ "currency", "orderValueDistribution", "orderBreakdown" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/analytics/sitewide/snapshot": { "post": { "tags": [ "Fetch Sitewide Analytics" ], "description": "Retrieve sitewide snapshot metrics for a time window.\n\nThe optional `feature` parameter is an object, not a string enum.\n\nUse `{ \"name\": \"performance\" }` for the core KPI subset, `{ \"name\": \"audience\", \"audience\": \"device_type\" }` for audience snapshots, `{ \"name\": \"order\" }` for order-focused snapshot metrics, or `{ \"name\": \"conversion\" }` for conversion funnel snapshot metrics. Omitting `feature` entirely returns the full sitewide metric set.\n\n### Response Structure\n\nThe response is a JSON object keyed by segment name, **not** a flat object with top-level metric fields.\n\nWhen no audience feature is specified (or `feature.name` is `\"performance\"`, `\"order\"`, or `\"conversion\"`), the response contains a single `\"All\"` key:\n\n```json\n{\n \"All\": {\n \"currency\": \"USD\",\n \"n_visitors\": { \"value\": 52763, \"pct_change\": 0.12 },\n \"conversion_rate\": { \"value\": 0.034, \"pct_change\": -0.05 },\n ...\n }\n}\n```\n\nWhen `feature.name` is `\"audience\"`, the response contains one key per audience segment plus a `\"__total\"` key:\n\n```json\n{\n \"Desktop\": { \"currency\": \"USD\", \"n_visitors\": { \"value\": 30000, \"pct_change\": 0.08 }, ... },\n \"Mobile\": { \"currency\": \"USD\", \"n_visitors\": { \"value\": 22763, \"pct_change\": 0.18 }, ... },\n \"__total\": { \"currency\": \"USD\", \"n_visitors\": { \"value\": 52763, \"pct_change\": 0.12 }, ... }\n}\n```\n\nEach segment object contains `currency` (string) and metric fields. Each metric field is an object with `value` (number) and `pct_change` (number) representing the percent change versus the comparison period. In audience view, per-segment metrics also include `pct_impact_to_total_change` (number), and the `__total` segment additionally includes `impact_from_visitor_mix_shift` (number).\n\n### Metric Availability by Feature\n\n- `performance` returns this KPI subset: `n_visitors`, `conversion_rate`, `n_orders`, `aov`, `net_revenue`, `gross_profit`, `gross_profit_per_visitor`, `net_revenue_per_visitor`, `gross_margin_pct`, `average_discount`, `pct_revenue_with_cogs`.\n- `order` returns this subset: `aov`, `n_visitors`, `n_orders`, `median_order_value`, `average_units_per_order`, `pct_orders_with_free_shipping`, `net_shipping_revenue_per_order`.\n- `conversion` returns this subset: `viewed_collection_page_rate`, `viewed_product_page_rate`, `add_to_cart_rate`, `checkout_begin_rate`, `conversion_rate`, `bounce_rate`, `abandoned_cart_rate`, `abandoned_checkout_rate`.\n- `audience` returns per-segment metrics plus a `__total` key:\n `n_sessions`, `n_visitors`, `n_orders`, `gross_revenue`, `net_revenue`, `order_cogs`, `conversion_rate`, `aov`, `net_revenue_per_visitor`, `shipping_cost`, `transaction_fees`, `tax`, `gross_profit`, `gross_profit_per_visitor`, `oli_net_product_revenue_with_cogs`, `oli_net_product_revenue`, `pct_revenue_with_cogs`.", "security": [ { "intelligems_access_token": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "description": "Start of analysis period as an ISO 8601 datetime string (e.g. '2025-01-01T00:00:00.000-05:00'). Defaults to 30 days ago.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "end": { "description": "End of analysis period as an ISO 8601 datetime string. Defaults to now.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "filters": { "description": "Optional analytics filters object. See the Filters Reference for available filter fields.", "type": "object", "properties": { "deviceType": { "description": "Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.", "anyOf": [ { "type": "string", "enum": [ "any", "mobile", "desktop" ] }, { "type": "null" } ] }, "visitorType": { "description": "Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.", "anyOf": [ { "type": "string", "enum": [ "any", "new", "returning" ] }, { "type": "null" } ] }, "sourceSitesOrChannels": { "description": "Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.", "type": "array", "items": { "type": "string", "enum": [ "Referral", "All Social", "Organic Social", "Paid Social", "Organic Search", "Paid Search", "Paid Shopping", "Email", "Google", "Facebook", "Instagram", "Linktree", "TikTok", "Twitter", "Direct", "SMS", "Other", "Meta", "Link Tree", "Wunderkind Text", "Youtube", "any" ] } }, "landingPage": { "description": "Filter by landing page URL path. Object with: landingPageUrlPath (string|null \u2014 the path to match), landingPageUrlPathFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull'). For 'isNull'/'isNotNull' operators, set landingPageUrlPath to null. Note: 'regex' is NOT supported here (unlike urlParam).", "anyOf": [ { "type": "object", "properties": { "landingPageUrlPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "landingPageUrlPathFilterType": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] }, { "type": "null" } ] } }, "required": [ "landingPageUrlPath", "landingPageUrlPathFilterType" ] }, { "type": "null" } ] }, "landingPageFilters": { "description": "Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against \u2014 omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.", "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] } }, "required": [ "filterType" ] } }, "landingPageFiltersOperator": { "description": "How multiple items in landingPageFilters are combined. 'or' (default) \u2014 session matches if any filter item matches. 'and' \u2014 session must match every filter item.", "type": "string", "enum": [ "or", "and" ] }, "countryCodes": { "description": "Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.", "type": "array", "items": { "type": "string" } }, "maxZScore": { "description": "Maximum Z-score threshold for outlier filtering on order revenue. Visitors with orders whose Z-score exceeds this value are excluded. Accepts number or numeric string. Null or omit to disable outlier filtering.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "landingPageTypes": { "description": "Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.", "type": "array", "items": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] } }, "allOrders": { "description": "Whether to include all orders or only matched orders.", "type": "boolean" } } }, "feature": { "description": "Optional feature selector object. Omit it or use `{ \"name\": \"performance\" }` for sitewide KPI snapshots, `{ \"name\": \"audience\", \"audience\": \"device_type\" }` for audience segment snapshots, `{ \"name\": \"order\" }` for order-focused metrics, or `{ \"name\": \"conversion\" }` for conversion funnel metrics.", "oneOf": [ { "type": "object", "properties": { "name": { "type": "string", "const": "performance" } }, "required": [ "name" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "audience" }, "audience": { "type": "string", "enum": [ "device_type", "visitor_type", "source_channel", "source_site", "country_code", "landing_page_full_path" ], "description": "Optional audience breakdown dimension. When provided, returns per-segment snapshot instead of site-level KPIs. Supported values: device_type, visitor_type, source_channel, source_site, country_code, landing_page_full_path." } }, "required": [ "name", "audience" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "order" } }, "required": [ "name" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "conversion" } }, "required": [ "name" ] } ], "type": "object" } } } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "currency": { "description": "ISO 4217 currency code for monetary values (e.g. 'USD').", "type": "string" }, "n_sessions": { "description": "Total number of sessions during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "n_visitors": { "description": "Total number of unique visitors during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "n_orders": { "description": "Total number of orders during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "gross_revenue": { "description": "Total gross revenue before discounts and returns.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "net_revenue": { "description": "Total net revenue during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "order_cogs": { "description": "Total cost of goods sold for all orders.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "lost_net_revenue": { "description": "Net revenue lost from returns and cancellations during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "discounts": { "description": "Total discount amount applied across all orders.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "average_discount": { "description": "Average discount rate during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "conversion_rate": { "description": "Overall site conversion rate during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "aov": { "description": "Average order value during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "net_revenue_per_visitor": { "description": "Average net revenue per visitor during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "discount_per_unit": { "description": "Average discount amount per unit sold.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "shipping_cost": { "description": "Total shipping cost across all orders.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "transaction_fees": { "description": "Total transaction/payment processing fees.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "tax": { "description": "Total tax collected across all orders.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "gross_profit": { "description": "Total gross profit during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "gross_margin_pct": { "description": "Gross margin as a percentage of net revenue.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "gross_profit_per_visitor": { "description": "Average gross profit per visitor during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "oli_net_product_revenue_with_cogs": { "description": "Net product revenue for line items that have cost of goods data.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "oli_net_product_revenue": { "description": "Net product revenue at the order line item level.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "median_order_value": { "description": "Median order value during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "average_units_per_order": { "description": "Average number of units per order.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pct_orders_with_free_shipping": { "description": "Percentage of orders with free shipping during the period.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "net_shipping_revenue_per_order": { "description": "Average net shipping revenue collected per order.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pct_revenue_with_cogs": { "description": "Percentage of revenue from products that have cost of goods data.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "viewed_collection_page_rate": { "description": "Percentage of sessions that viewed a collection page.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "viewed_product_page_rate": { "description": "Percentage of sessions that viewed a product detail page.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "add_to_cart_rate": { "description": "Percentage of sessions that added at least one product to cart.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "checkout_begin_rate": { "description": "Percentage of sessions that started the checkout flow.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "bounce_rate": { "description": "Percentage of sessions that ended without navigating to a second page.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "abandoned_cart_rate": { "description": "Percentage of sessions that added to cart but did not convert.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "abandoned_checkout_rate": { "description": "Percentage of sessions that started checkout but did not convert.", "type": "object", "properties": { "pct_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pct_impact_to_total_change": { "description": "For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impact_from_visitor_mix_shift": { "description": "For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } } } } } } }, "/v25-10-beta/analytics/sitewide/timeseries": { "post": { "tags": [ "Fetch Sitewide Analytics" ], "security": [ { "intelligems_access_token": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "description": "Start of analysis period as an ISO 8601 datetime string (e.g. '2025-01-01T00:00:00.000-05:00'). Defaults to 30 days ago.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "end": { "description": "End of analysis period as an ISO 8601 datetime string. Defaults to now.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "feature": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "string", "const": "performance" } }, "required": [ "name" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "audience" }, "audience": { "type": "string", "enum": [ "device_type", "visitor_type", "source_channel", "source_site", "country_code", "landing_page_full_path" ], "description": "Optional audience breakdown dimension. When provided, returns per-segment snapshot instead of site-level KPIs. Supported values: device_type, visitor_type, source_channel, source_site, country_code, landing_page_full_path." } }, "required": [ "name", "audience" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "order" } }, "required": [ "name" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "conversion" } }, "required": [ "name" ] } ], "type": "object" }, "granularity": { "default": "week", "description": "Time bucket granularity. Supported values: day, week, month. Defaults to week.", "type": "string", "enum": [ "day", "week", "month" ] }, "filters": { "description": "Optional analytics filters object. See the Filters Reference for available filter fields.", "type": "object", "properties": { "deviceType": { "description": "Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.", "anyOf": [ { "type": "string", "enum": [ "any", "mobile", "desktop" ] }, { "type": "null" } ] }, "visitorType": { "description": "Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.", "anyOf": [ { "type": "string", "enum": [ "any", "new", "returning" ] }, { "type": "null" } ] }, "sourceSitesOrChannels": { "description": "Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.", "type": "array", "items": { "type": "string", "enum": [ "Referral", "All Social", "Organic Social", "Paid Social", "Organic Search", "Paid Search", "Paid Shopping", "Email", "Google", "Facebook", "Instagram", "Linktree", "TikTok", "Twitter", "Direct", "SMS", "Other", "Meta", "Link Tree", "Wunderkind Text", "Youtube", "any" ] } }, "landingPage": { "description": "Filter by landing page URL path. Object with: landingPageUrlPath (string|null \u2014 the path to match), landingPageUrlPathFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull'). For 'isNull'/'isNotNull' operators, set landingPageUrlPath to null. Note: 'regex' is NOT supported here (unlike urlParam).", "anyOf": [ { "type": "object", "properties": { "landingPageUrlPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "landingPageUrlPathFilterType": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] }, { "type": "null" } ] } }, "required": [ "landingPageUrlPath", "landingPageUrlPathFilterType" ] }, { "type": "null" } ] }, "landingPageFilters": { "description": "Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against \u2014 omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.", "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } }, "filterType": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull" ] } }, "required": [ "filterType" ] } }, "landingPageFiltersOperator": { "description": "How multiple items in landingPageFilters are combined. 'or' (default) \u2014 session matches if any filter item matches. 'and' \u2014 session must match every filter item.", "type": "string", "enum": [ "or", "and" ] }, "countryCodes": { "description": "Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.", "type": "array", "items": { "type": "string" } }, "maxZScore": { "description": "Maximum Z-score threshold for outlier filtering on order revenue. Visitors with orders whose Z-score exceeds this value are excluded. Accepts number or numeric string. Null or omit to disable outlier filtering.", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "landingPageTypes": { "description": "Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.", "type": "array", "items": { "type": "string", "enum": [ "PDP", "Collection", "Content", "Blog", "Homepage", "Search", "Cart", "Other" ] } }, "allOrders": { "description": "Whether to include all orders or only matched orders.", "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code for monetary values (e.g. 'USD')." }, "granularity": { "type": "string", "enum": [ "day", "week", "month" ], "description": "The granularity used for time bucketing." }, "segments": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "dt": { "type": "string" } }, "required": [ "dt" ], "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "summary": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "required": [ "data" ], "additionalProperties": false }, "description": "Time series data keyed by segment name. Contains 'All' for performance/order requests, or per-segment keys when `feature.name` is `audience`." } }, "required": [ "currency", "granularity", "segments" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/experiences": { "post": { "tags": [ "Create Experience" ], "description": "Creates a new experience.\n\nThe experience will be created in a draft state and must be activated separately before it will be served to visitors.\n\n### Required Fields\n\n- `name` - A unique name for the experience\n- `type` - The type of test (content, redirect, etc.)\n- `variations` - At least one variation must be provided", "security": [ { "intelligems_access_token": [] } ], "x-codeSamples": [ { "lang": "Shell", "label": "URL Redirect Test", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/experiences' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"experience\": {\n \"name\": \"URL Redirect Test - Test to New-Test\",\n \"description\": \"Testing redirect from /test to /new-test\",\n \"type\": \"content/url\",\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\",\n \"country\": \"US\",\n \"suffix\": \"\"\n },\n \"experienceAnalysis\": {\n \"analyticsViewType\": \"none\"\n },\n \"variations\": [\n {\n \"name\": \"Control - No Redirect\",\n \"percentage\": 50,\n \"isControl\": true,\n \"order\": 1,\n \"redirects\": []\n },\n {\n \"name\": \"Variant - Redirect to New-Test\",\n \"percentage\": 50,\n \"isControl\": false,\n \"order\": 2,\n \"redirects\": [\n {\n \"group\": 1,\n \"originUrl\": \"/test\",\n \"destinationUrl\": \"/new-test\",\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": false,\n \"isTemplateTest\": false,\n \"queryParams\": []\n }\n ]\n }\n ]\n }\n}'" }, { "lang": "Shell", "label": "Theme Test", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/experiences' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"experience\": {\n \"name\": \"Theme Test\",\n \"description\": \"Testing theme\",\n \"type\": \"content/theme\",\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\",\n \"country\": \"US\",\n \"suffix\": \"\"\n },\n \"experienceAnalysis\": {\n \"analyticsViewType\": \"none\"\n },\n \"variations\": [\n {\n \"name\": \"Control\",\n \"percentage\": 25,\n \"isControl\": true,\n \"order\": 1,\n \"redirects\": [\n {\n \"group\": 1,\n \"originUrl\": \"/\",\n \"destinationUrl\": \"/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068324949\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n },\n {\n \"name\": \"Variant - New Theme\",\n \"percentage\": 75,\n \"isControl\": false,\n \"order\": 2,\n \"redirects\": [\n {\n \"group\": 1,\n \"originUrl\": \"/\",\n \"destinationUrl\": \"/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068292181\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n }\n ]\n }\n}'" }, { "lang": "Shell", "label": "Offer Test", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/experiences' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"experience\": {\n \"name\": \"Offer Test - 10% Off vs $10 Off\",\n \"description\": \"Testing 10% off all products vs $10 off all products\",\n \"type\": \"personalization/offer\",\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\",\n \"country\": \"US\",\n \"suffix\": \"\"\n },\n \"experienceAnalysis\": {\n \"analyticsViewType\": \"none\"\n },\n \"variations\": [\n {\n \"name\": \"Control - 10% Off All Products\",\n \"percentage\": 50,\n \"isControl\": true,\n \"order\": 1,\n \"offer\": {\n \"enabled\": true,\n \"isTest\": true,\n \"isArchived\": false,\n \"name\": \"10% Off All Products\",\n \"unitType\": \"dollar\",\n \"discountType\": \"percentage\",\n \"tiers\": [\n {\n \"minimumUnits\": 0,\n \"maximumUnits\": 999999,\n \"unitDiscount\": 10,\n \"discountTitle\": \"10% Off Your Order\",\n \"giftWithPurchaseTitle\": null,\n \"isFreeShipping\": false,\n \"isGiftWithPurchase\": false,\n \"giftWithPurchaseProductId\": null,\n \"giftWithPurchaseVariantId\": null,\n \"autoAddGiftWithPurchase\": false,\n \"giftWithPurchaseHandle\": null\n }\n ],\n \"maximumDollarDiscount\": null,\n \"discountApplicationType\": \"cartDiscount\",\n \"discountApplicationMethod\": \"perOrder\",\n \"combinesWithIntelligems\": false,\n \"combinesWithShopify\": false,\n \"shouldRejectCodes\": false,\n \"shippingDiscount\": null,\n \"requireSameItem\": false\n }\n },\n {\n \"name\": \"Variant - $10 Off All Products\",\n \"percentage\": 50,\n \"isControl\": false,\n \"order\": 2,\n \"offer\": {\n \"enabled\": true,\n \"isTest\": true,\n \"isArchived\": false,\n \"name\": \"$10 Off All Products\",\n \"unitType\": \"dollar\",\n \"discountType\": \"dollar\",\n \"tiers\": [\n {\n \"minimumUnits\": 0,\n \"maximumUnits\": 999999,\n \"unitDiscount\": 10,\n \"discountTitle\": \"$10 Off Your Order\",\n \"giftWithPurchaseTitle\": null,\n \"isFreeShipping\": false,\n \"isGiftWithPurchase\": false,\n \"giftWithPurchaseProductId\": null,\n \"giftWithPurchaseVariantId\": null,\n \"autoAddGiftWithPurchase\": false,\n \"giftWithPurchaseHandle\": null\n }\n ],\n \"maximumDollarDiscount\": null,\n \"discountApplicationType\": \"cartDiscount\",\n \"discountApplicationMethod\": \"perOrder\",\n \"combinesWithIntelligems\": false,\n \"combinesWithShopify\": false,\n \"shouldRejectCodes\": false,\n \"shippingDiscount\": null,\n \"requireSameItem\": false\n }\n }\n ]\n }\n}'" }, { "lang": "Shell", "label": "Onsite Edits Test", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/experiences' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"experience\": {\n \"name\": \"Staff Pick | Hide/Show Test\",\n \"description\": \"Testing hiding vs showing the staff pick badge\",\n \"type\": \"content/onsiteEdits\",\n \"experienceAnalysis\": {\n \"analyticsViewType\": \"sitewide_orders\"\n },\n \"variations\": [\n {\n \"name\": \"Show Staff Pick\",\n \"percentage\": 50,\n \"isControl\": true,\n \"order\": 1,\n \"onsiteEdits\": [\n {\n \"onsiteEditType\": \"hide\",\n \"find\": null,\n \"title\": \"\",\n \"isRegex\": false,\n \"replace\": \"\",\n \"querySelectors\": [\".staff-pick-badge\"],\n \"skip\": false,\n \"remove\": false,\n \"isHtml\": false,\n \"isImage\": false,\n \"insertType\": null\n }\n ]\n },\n {\n \"name\": \"Hide Staff Pick\",\n \"percentage\": 50,\n \"isControl\": false,\n \"order\": 2,\n \"onsiteEdits\": [\n {\n \"onsiteEditType\": \"hide\",\n \"find\": null,\n \"title\": \"\",\n \"isRegex\": false,\n \"replace\": \"\",\n \"querySelectors\": [\".staff-pick-badge\"],\n \"skip\": false,\n \"remove\": true,\n \"isHtml\": false,\n \"isImage\": false,\n \"insertType\": null\n }\n ]\n }\n ]\n }\n}'" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "experience": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Display name shown in dashboards and reports." }, "description": { "description": "Internal note explaining what this experience tests. Helpful for team context.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "description": "Currency for price display and analytics. Omit to default to USD.", "anyOf": [ { "type": "object", "properties": { "code": { "default": "USD", "description": "ISO 4217 currency code used for analytics and price calculations.", "type": "string" }, "country": { "description": "ISO country code for locale-specific formatting.", "type": "string" }, "options": { "description": "Additional locale-specific formatting options." }, "symbol": { "default": "$", "description": "Display symbol prepended to amounts (e.g., '$', '\u20ac').", "type": "string" }, "suffix": { "description": "Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').", "type": "string" } } }, { "type": "null" } ] }, "previewPath": { "description": "Store URL path for generating preview links (e.g., '/products/example').", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "content/advanced", "content/onsiteEdits", "content/url", "content/theme", "content/template", "personalization", "personalization/offer" ], "description": "Immutable after creation. Must match the existing value from GET response." }, "experienceAnalysis": { "type": "object", "properties": { "analyticsViewType": { "default": "none", "description": "Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted.", "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ] } }, "description": "Controls which orders are included in analytics results." }, "variations": { "description": "Full replacement \u2014 include ALL variations to keep. Omitted variations are deleted. One must be control, percentages must sum to 100. Match variation mechanisms to experience type: onsiteEdits for DOM changes, onsiteInjection for CSS/JS, redirects for URL/theme/template tests.", "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Display name (e.g., 'Control', 'Variant A'). Must be unique across variations." }, "percentage": { "type": "number", "minimum": 0, "maximum": 100, "description": "Traffic allocation weight. All percentages across variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display order in analytics. Must be unique across variations. 0-indexed." }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ] } } } ] } }, "required": [ "key", "type", "filter" ] }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } } } } }, "required": [ "id", "expression" ] } }, "onsiteEdits": { "default": [], "description": "Full replacement \u2014 include ALL edits to keep. Omitted edits are deleted. ONLY for DOM content changes (text replacement, HTML insertion, image swaps, element removal). Do NOT create onsiteEdits for visual styling changes like colors, backgrounds, fonts, or layout \u2014 use onsiteInjection.customCss instead. Leave as empty array when only CSS/JS changes are needed.", "type": "array", "items": { "type": "object", "properties": { "onsiteEditType": { "description": "Content modification strategy (rich HTML, plain text, image swap, or element removal).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to find on the page. Set isRegex=true for regex. Null when using querySelectors with 'hide' or 'image' type." }, "title": { "description": "Dashboard label for organizing multiple edits.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "Set to true to interpret 'find' as a regex pattern.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content: HTML markup for 'html' type, plain text for 'text', image URL for 'image'.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping where the edit applies (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "Set to true to temporarily disable without deleting.", "type": "boolean" }, "remove": { "default": false, "description": "Set to true to remove the matched element entirely instead of replacing.", "type": "boolean" }, "groupId": { "description": "Edits sharing a groupId are managed together as a unit.", "type": "string" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to target element. Null for content replacement (default)." }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname to match for image replacement. Mutually exclusive with querySelectors for image edits." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "find", "insertType" ] } }, "onsiteInjection": { "description": "Full replacement. Set to null to remove. Use for all visual styling changes (background-color, font-size, colors, borders, layout, etc.) via customCss, and custom behavior via customJs. CSS-only changes should use ONLY this field with an empty onsiteEdits array \u2014 do not create a corresponding onsiteEdit.", "anyOf": [ { "type": "object", "properties": { "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "customCss", "customJs", "jsInjectionMode" ] }, { "type": "null" } ] }, "offer": { "anyOf": [ { "type": "object", "properties": { "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "description": "Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).", "type": "array", "items": { "type": "object", "properties": { "minimumUnits": { "default": 1, "type": "number", "minimum": 0 }, "maximumUnits": { "default": 1, "type": "number", "minimum": 0 }, "unitDiscount": { "default": 1, "type": "number", "minimum": 0 }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ] } } }, "required": [ "type", "rules" ] } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ] }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] } }, "required": [ "name", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount" ] }, { "type": "null" } ] }, "redirects": { "default": [], "type": "array", "items": { "type": "object", "properties": { "group": { "type": "number", "description": "Redirects sharing the same originUrl should use the same group number." }, "originUrl": { "type": "string", "description": "URL pattern to match. Matching behavior controlled by 'filter' field." }, "destinationUrl": { "description": "Target URL. Required when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Appended to the destination URL.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ] } }, "skip": { "type": "boolean", "description": "Set to true to temporarily disable without deleting." }, "isThemeTest": { "type": "boolean", "description": "Set to true for Shopify theme testing. Use with content/theme experience type." }, "isTemplateTest": { "type": "boolean", "description": "Set to true for Shopify template testing. Use with content/template experience type." }, "templateType": { "description": "Required when isTemplateTest is true.", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Template suffix variations to test. Required when isTemplateTest is true.", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "Set to true to fire only once per visitor session.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "How originUrl is matched against the current page URL.", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to find in the URL. Required when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "Full replacement navigates to destinationUrl; partial replacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "group", "originUrl", "skip", "isThemeTest", "isTemplateTest" ] } } }, "required": [ "name", "percentage", "order" ] } }, "audience": { "description": "Omit entirely to remove audience targeting from the experience.", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Set to true to enforce filter rules. When false, all visitors are included." }, "audienceType": { "description": "Complexity level: prebuilt common rules, simple custom rules, or advanced expression trees.", "type": "string", "enum": [ "common", "custom", "advanced" ] }, "elseAction": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "Fallback for visitors matching no filter: 'randomVariation' assigns randomly (most common), 'assignVariation' forces a specific variation (set elseVariationIndex), 'experienceExclude' removes from experience, 'leaveUnassigned' skips assignment." }, "elseExcludeFromAnalytics": { "default": false, "description": "Set to true to exclude non-matching visitors from analytics.", "type": "boolean" }, "filters": { "default": [], "description": "Evaluated in priority order (0-indexed). Each filter defines a targeting condition and resulting action.", "type": "array", "items": { "type": "object", "properties": { "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Evaluation order. 0-indexed. Filters with lower values are evaluated first." }, "action": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly." }, "filterType": { "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ], "description": "Category of targeting rule (e.g., UTM parameters, device type, visitor type)." }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value" ] }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } } } }, { "type": "null" } ], "description": "Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both." }, "expressionType": { "description": "Whether this uses prebuilt common rules or custom expression logic.", "anyOf": [ { "type": "string", "enum": [ "common", "custom" ] }, { "type": "null" } ] }, "variationId": { "description": "Variation to assign when action is 'assignVariation'. References a variation in the parent experience.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "excludeFromAnalytics": { "default": false, "description": "When true, visitors matching this filter are excluded from analytics even if included in the experience.", "type": "boolean" } }, "required": [ "priority", "action", "filterType" ] } }, "evaluationFrequency": { "description": "Seconds between re-evaluations for a visitor. Omit for default.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "elseVariationIndex": { "description": "0-based index into the variations array. Use instead of elseVariationId since IDs don't exist yet during creation.", "type": "string" } }, "required": [ "enabled", "elseAction" ] }, "experiencePageTargeting": { "default": [], "description": "Full replacement \u2014 include ALL page targeting rules to keep. Omitted rules are deleted.", "type": "array", "items": { "type": "object", "properties": { "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value" ] }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } } } }, { "type": "null" } ] } } } }, "experienceKeyMetrics": { "default": [], "description": "Full replacement \u2014 include ALL metrics to keep. Omitted metrics are deleted. Exactly one must be primary.", "type": "array", "items": { "type": "object", "properties": { "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display order in analytics. Must be unique across metrics. 0-indexed." }, "isPrimary": { "default": false, "description": "Exactly one metric per experience must be primary.", "type": "boolean" }, "standardEventId": { "description": "Standard e-commerce event to track. Mutually exclusive with experienceCustomMetricId -- set exactly one.", "anyOf": [ { "type": "string", "enum": [ "conversionRate", "addToCartRate", "abandonedCartRate", "abandonedCheckoutRate", "checkoutBeginRate", "checkoutEnterContactInfoRate", "checkoutAddressSubmittedRate", "viewProductPageRate", "viewCollectionPageRate", "netRevenuePerVisitor", "netProductRevenuePerOrder", "netRevenuePerOrder", "avgUnitsPerOrder", "avgProductRevenuePerUnit", "profitPerVisitor", "profitPerOrder", "pctOrdersFreeShipping", "netShippingRevenuePerOrder", "subscriptionOrdersPerVisitor", "subscriptionRevenuePerVisitor", "subscriptionProfitPerVisitor", "subscriptionProductRevenuePerOrder", "avgDiscountPerDiscountedOrder", "avgDiscountPerAllOrders", "pctSubscriptionOrders", "subscriptionRevenuePerOrder" ] }, { "type": "null" } ] }, "experienceCustomMetricId": { "description": "References a custom metric. Mutually exclusive with standardEventId -- set exactly one.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "order" ] } } }, "required": [ "name", "type", "experienceAnalysis", "variations" ], "description": "The complete experience object containing settings, variations, audience, page targeting, and key metrics. For PUT: include id fields from the GET response on all nested entities." } }, "required": [ "experience" ] } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "experience": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "name": { "type": "string", "description": "Display name shown in dashboards and reports." }, "isPreview": { "default": true, "description": "True while in draft mode. Must be set to false before the experience can be started.", "type": "boolean" }, "description": { "description": "Internal note explaining what this experience tests.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "devicePreview": { "description": "Device and path configuration for the preview iframe.", "anyOf": [ { "type": "object", "properties": { "device": { "default": "desktop", "description": "Viewport to simulate when rendering the preview.", "type": "string", "enum": [ "any", "mobile", "desktop" ] }, "path": { "default": "/", "description": "Storefront URL path to load in the preview (e.g., '/products/example').", "type": "string" } }, "required": [ "device", "path" ], "additionalProperties": false, "description": "Device and path configuration for previewing the experience." }, { "type": "null" } ] }, "organizationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only. The Shopify store that owns this experience." }, "type": { "type": "string", "enum": [ "content/advanced", "content/onsiteEdits", "content/url", "content/theme", "content/template", "personalization", "personalization/offer", "pricing", "shipping", "sitewide", "checkoutBlock", "postPurchase" ], "description": "Determines which variation fields are relevant: content/onsiteEdits for DOM edits, content/advanced for CSS/JS injection, content/url for redirect split tests, content/theme for theme tests, content/template for template tests." }, "category": { "type": "string", "enum": [ "experiment", "personalization" ], "description": "Distinguishes A/B experiments (statistical testing) from personalization rules (deterministic targeting)." }, "status": { "type": "string", "enum": [ "pending", "started", "ended", "paused" ], "description": "Server-managed lifecycle state. Transitions via start/pause/end actions: pending -> started -> paused/ended." }, "testTypes": { "type": "object", "properties": { "hasTestPricing": { "type": "boolean", "description": "Server-generated. Read-only. True when price testing is active." }, "hasTestShipping": { "type": "boolean", "description": "Server-generated. Read-only. True when shipping rate testing is active." }, "hasTestCampaign": { "type": "boolean", "description": "Server-generated. Read-only. True when campaign/offer testing is active." }, "hasTestContent": { "type": "boolean", "description": "Server-generated. Read-only. True when any content variation type is enabled." }, "hasTestContentUrl": { "type": "boolean", "description": "Server-generated. Read-only. True when URL redirect variations are in use." }, "hasTestContentAdvanced": { "type": "boolean", "description": "Server-generated. Read-only. True when custom JS/CSS variations are in use." }, "hasTestContentOnsite": { "type": "boolean", "description": "Server-generated. Read-only. True when visual onsite edit variations are in use." }, "hasTestContentTemplate": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify template variations are in use." }, "hasTestContentTheme": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify theme variations are in use." }, "hasTestOnsiteInjections": { "type": "boolean", "description": "Server-generated. Read-only. True when CSS/JS injection variations are in use." }, "hasTestCheckoutBlocks": { "type": "boolean", "description": "Server-generated. Read-only. True when checkout block variations are in use." }, "hasTestPostPurchase": { "type": "boolean", "description": "Server-generated. Read-only. True when post-purchase upsell variations are in use." } }, "required": [ "hasTestPricing", "hasTestShipping", "hasTestCampaign", "hasTestContent", "hasTestContentUrl", "hasTestContentAdvanced", "hasTestContentOnsite", "hasTestContentTemplate", "hasTestContentTheme", "hasTestOnsiteInjections", "hasTestCheckoutBlocks", "hasTestPostPurchase" ], "additionalProperties": false, "description": "Server-generated. Read-only. Flags derived from 'type' indicating which variation capabilities are active." }, "experiencePageTargeting": { "default": [], "description": "URL rules controlling which storefront pages this experience activates on. Empty means all pages.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filter": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "filterType": { "default": "url", "type": "string", "enum": [ "utm", "url", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie" ] }, "value": { "type": "string" }, "order": { "type": "number" }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "filterType", "value", "order" ], "additionalProperties": false } }, "experienceProductTargeting": { "default": [], "description": "Product attribute rules controlling which products this experience applies to. Empty means all products.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "target": { "type": "string", "enum": [ "productPage", "productCard" ], "description": "Storefront context where targeting rules are evaluated (product detail pages vs collection/search listings)." }, "expression": { "description": "Boolean expression tree of product attribute conditions. Each node has either a 'query' (leaf) or 'operator' (combinator).", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Product attribute to filter on. Determines which product property is evaluated." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Expected value. String for text attributes (productId, collection, tag); number for numeric attributes (price, inventory)." }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan" ], "description": "Comparison operator for evaluating the product attribute against the value." }, "type": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Mirrors the key field. Determines attribute category for validation." } }, "required": [ "key", "value", "filter", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "target" ], "additionalProperties": false } }, "experienceActions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string", "enum": [ "start", "pause", "end", "delete", "reset" ] }, "actionTs": { "type": "number" }, "performedBy": { "description": "Email of the user who triggered this lifecycle event. Resolved from History records by matching action type and timestamp within a 5-minute window. Null if no matching History record is found, or if the record has no associated user. Currently only populated by GET /experiences/{experienceId}; list endpoints return null.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "action", "actionTs" ], "additionalProperties": false }, "description": "Server-generated. Read-only. Lifecycle state transitions (start, pause, end, delete, reset) recorded for this experience. On GET /experiences/{experienceId}, each entry includes a `performedBy` field with the triggering user's email, resolved from History records (may be null if unresolvable). Distinct from the list endpoint's raw `history` field, which contains broader user-action records." }, "experienceIntegrations": { "default": [], "description": "Connected third-party integrations (e.g., Google Analytics, Segment).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAtTs": { "type": "number" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "enum": [ "Recharge", "StayAi", "GrowLTV", "OneClickUpsell", "Google", "Amped", "Clarity", "Hotjar", "Heatmap", "CustomApi", "Klaviyo", "Slack", "Amplitude", "Heap", "Segment", "IntelligemsAPI", "IntelligemsMcp" ] }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "globalSettings": {}, "apis": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessToken": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "read_experiments", "write_experiments", "write_test_groups", "read_integrations" ] } }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "name", "accessToken", "scopes", "organization" ], "additionalProperties": false } }, "createdAtTs": { "type": "number" }, "lastUpdateTs": { "type": "number" } }, "required": [ "id", "name", "description", "enabled", "globalSettings", "apis" ], "additionalProperties": false }, "experienceSettings": {}, "enabled": { "default": false, "type": "boolean" } }, "required": [ "id", "createdAtTs", "integration", "experienceSettings", "enabled" ], "additionalProperties": false } }, "experienceCustomMetrics": { "default": [], "description": "Custom event-based metrics tracked alongside standard key metrics.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "number", "description": "Display position in the analytics dashboard. 0-indexed." }, "customEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the custom event definition configured in the organization's analytics settings." }, "customEvent": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "pageView" }, "settings": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "productPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "handle": { "type": "string" } }, "required": [ "productId", "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "collectionPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "handle": { "type": "string" } }, "required": [ "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "clickEvent" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "elementViewed" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "scrollDepth" }, "settings": { "type": "object", "properties": { "mobile": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false } }, "required": [ "mobile", "desktop" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptEvent" }, "settings": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptImportedEvent" }, "settings": { "type": "object", "properties": { "registered": { "type": "boolean" } }, "required": [ "registered" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false } ], "description": "Server-generated. Read-only. Expanded custom event definition with name, tracking details, and configuration.", "type": "object" } }, "required": [ "id", "experienceId", "order", "customEventId", "customEvent" ], "additionalProperties": false } }, "experienceKeyMetrics": { "default": [], "description": "Business metrics (revenue, conversion, AOV, etc.) used to evaluate test performance. One must be primary.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display position in the analytics dashboard. 0-indexed." }, "isPrimary": { "default": false, "description": "The primary metric determines the main success signal for the test. Exactly one per experience.", "type": "boolean" }, "standardEventId": { "description": "Standard e-commerce event (e.g., revenue, conversion). Mutually exclusive with experienceCustomMetricId.", "anyOf": [ { "type": "string", "enum": [ "conversionRate", "addToCartRate", "abandonedCartRate", "abandonedCheckoutRate", "checkoutBeginRate", "checkoutEnterContactInfoRate", "checkoutAddressSubmittedRate", "viewProductPageRate", "viewCollectionPageRate", "netRevenuePerVisitor", "netProductRevenuePerOrder", "netRevenuePerOrder", "avgUnitsPerOrder", "avgProductRevenuePerUnit", "profitPerVisitor", "profitPerOrder", "pctOrdersFreeShipping", "netShippingRevenuePerOrder", "subscriptionOrdersPerVisitor", "subscriptionRevenuePerVisitor", "subscriptionProfitPerVisitor", "subscriptionProductRevenuePerOrder", "avgDiscountPerDiscountedOrder", "avgDiscountPerAllOrders", "pctSubscriptionOrders", "subscriptionRevenuePerOrder" ] }, { "type": "null" } ] }, "experienceCustomMetricId": { "description": "References a custom event metric. Mutually exclusive with standardEventId. Exactly one of these must be set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "order", "isPrimary" ], "additionalProperties": false } }, "currency": { "description": "Currency settings for price display and analytics calculations. Null inherits store default.", "anyOf": [ { "type": "object", "properties": { "code": { "default": "USD", "description": "ISO 4217 currency code used for analytics and price calculations.", "type": "string" }, "country": { "description": "ISO country code for locale-specific formatting.", "type": "string" }, "options": { "description": "Additional locale-specific formatting options." }, "symbol": { "default": "$", "description": "Display symbol prepended to amounts (e.g., '$', '\u20ac').", "type": "string" }, "suffix": { "description": "Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').", "type": "string" } }, "required": [ "code", "symbol" ], "additionalProperties": false }, { "type": "null" } ] }, "variations": { "default": [], "description": "Test variants including the control. One must be control; traffic percentages must sum to 100.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "name": { "type": "string", "description": "Display name (e.g., 'Control', 'Variant A'). Unique within the experience." }, "percentage": { "type": "number", "description": "Traffic allocation weight. All percentages across sibling variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order in the analytics dashboard. 0-indexed." }, "priceChange": { "description": "Price adjustment amount for pricing-type experiences. Positive increases price, negative discounts. Use priceChange for simple price A/B tests; use offer for structured discount campaigns (tiered, BOGO, free shipping).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priceChangeUnit": { "description": "How priceChange is applied: as a percentage of the original price or a fixed monetary amount.", "anyOf": [ { "type": "string", "enum": [ "percent", "dollar" ] }, { "type": "null" } ] }, "priceRoundingType": { "description": "Rounding strategy applied after priceChange (e.g., round up, round down, charm pricing).", "anyOf": [ { "type": "string", "enum": [ "none", "nearest", "up", "down" ] }, { "type": "null" } ] }, "priceRoundingAmount": { "description": "Target value for rounding (e.g., 0.99 for charm pricing like $X.99).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onsiteEdits": { "default": [], "description": "DOM content modifications (text, HTML, image swaps, element removal). For CSS styling changes, use onsiteInjections instead.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "onsiteEditType": { "description": "Content modification strategy (html, text, image, or hide).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to locate on the page. Interpreted as regex when isRegex is true." }, "title": { "description": "Dashboard label for identifying this edit.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "When true, 'find' is treated as a regular expression.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content. Interpretation depends on onsiteEditType: HTML markup, plain text, or image URL.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping which DOM elements this edit targets (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "When true, this edit is temporarily disabled without being deleted.", "type": "boolean" }, "remove": { "default": false, "description": "When true, the matched element is removed from the DOM instead of having its content replaced.", "type": "boolean" }, "groupId": { "description": "Groups related edits together so they can be managed as a unit.", "type": "string" }, "isHtml": { "default": false, "type": "boolean" }, "isImage": { "default": false, "type": "boolean" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to the target (beforebegin, afterbegin, beforeend, afterend). Null means content replacement." }, "createdAtUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Server-generated. Read-only. Storefront URL where this edit was originally created via the visual editor." }, "createdAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname for locating images to replace. When set, images are found by URL match; when null, querySelectors is used instead." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "find", "isRegex", "replace", "querySelectors", "skip", "remove", "isHtml", "isImage", "insertType" ], "additionalProperties": false } }, "onsiteInjections": { "description": "CSS styling and custom JS injection. At most one per variation. For DOM content changes (text, images, HTML), use onsiteEdits instead.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "type" ], "additionalProperties": false, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "jsInjectionMode" ], "additionalProperties": false }, { "type": "null" } ] }, "offer": { "description": "Structured discount configuration (tiered volume discounts, cart-level discounts, gift-with-purchase, free shipping). Use offer for campaign/discount experiences; use priceChange for simple price A/B tests.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation this offer belongs to." }, "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "description": "Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "minimumUnits": { "default": 1, "type": "number" }, "maximumUnits": { "default": 1, "type": "number" }, "unitDiscount": { "default": 1, "type": "number" }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "minimumUnits", "maximumUnits", "unitDiscount", "discountTitle", "giftWithPurchaseTitle", "isFreeShipping", "isGiftWithPurchase", "autoAddGiftWithPurchase" ], "additionalProperties": false } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ], "additionalProperties": false } } }, "required": [ "type", "rules" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ], "additionalProperties": false }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] } }, "required": [ "id", "variationId", "enabled", "isTest", "isArchived", "name", "unitType", "discountType", "tiers", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount", "requireSameItem", "subscriptionApplicationType" ], "additionalProperties": false }, { "type": "null" } ] }, "offerId": { "description": "Server-generated. Read-only. References the associated offer. Populated when offer is set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "shippingRateGroups": { "description": "Shipping rate overrides. Only populated for shipping test experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupType": { "type": "string", "enum": [ "flatRate", "flatRateWithThreshold", "thresholdOnly", "tieredByPriceOrWeight", "custom" ] }, "position": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "amount": { "type": "number" }, "rateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rateType": { "type": "string", "enum": [ "amount", "threshold", "tier" ] }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SRD", "STD", "SZL", "THB", "TJS", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "min": { "default": 0, "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "conditionType": { "type": "string", "enum": [ "currency", "weight" ] }, "unit": { "anyOf": [ { "type": "string", "enum": [ "g", "kg", "lb", "oz" ] }, { "type": "null" } ] } }, "required": [ "min", "conditionType" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "amount", "rateType", "currency" ], "additionalProperties": false } }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "groupType", "position", "rates", "variationId" ], "additionalProperties": false } }, "excludeProducts": { "description": "When true, specific products are excluded from price changes. Use excludeProducts when most products should be tested and only a few excluded. Mutually exclusive with includeProducts.", "default": false, "type": "boolean" }, "includeProducts": { "description": "When true, only specific products receive price changes. Use includeProducts when only a few products should be tested. Mutually exclusive with excludeProducts.", "default": false, "type": "boolean" }, "testExperienceId": { "description": "Links to another experience for advanced multi-experience configurations.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "functionSyncError": { "default": false, "description": "Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.", "type": "boolean" }, "redirects": { "description": "URL redirect rules for content/url experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "group": { "type": "number", "description": "Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "originUrl": { "type": "string", "description": "URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field." }, "destinationUrl": { "description": "Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Key-value pairs appended to the destination URL as query parameters.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ], "additionalProperties": false } }, "skip": { "type": "boolean", "description": "When true, this redirect is temporarily disabled." }, "isThemeTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify themes. Used with content/theme experiences." }, "isTemplateTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify templates. Used with content/template experiences." }, "templateType": { "description": "Shopify template type being tested (e.g., product, collection).", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "When true, the redirect fires only once per visitor session to avoid redirect loops.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "id", "group", "variationId", "originUrl", "queryParams", "skip", "isThemeTest", "isTemplateTest", "templateSuffixes", "redirectOnce", "filter", "redirectType" ], "additionalProperties": false } }, "userInterfaces": { "description": "UI widget configurations displayed for this variation.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "isEnabled": { "type": "boolean" }, "isArchived": { "default": false, "type": "boolean" }, "widget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "enabledSitewide": { "default": false, "type": "boolean" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "widgetType": { "type": "string", "enum": [ "messageBoxPopup", "messageBoxSlideOut", "quantityButtons", "discountProgressBar", "shippingProgressBar" ] }, "config": { "type": "object", "properties": { "desktop": {}, "mobile": {} }, "additionalProperties": false } }, "required": [ "id", "name", "enabledSitewide", "widgetType", "config" ], "additionalProperties": false }, "widgetId": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "quantityButtons", "progressBar", "messageBox" ] }, "variationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "desktopVariables": { "anyOf": [ {}, { "type": "null" } ] }, "mobileVariables": { "anyOf": [ {}, { "type": "null" } ] }, "styleOverrides": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "id", "isArchived", "widgetId" ], "additionalProperties": false } }, "checkoutBlocks": { "description": "Shopify checkout extensibility block configurations for this variation.", "default": [], "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "trustBadge" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconSize": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageSize": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 500 }, { "type": "null" } ] }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaSpacing": { "type": "string" } }, "required": [ "order", "type", "imageSize", "imageSizeUnit", "mediaSpacing" ], "additionalProperties": false } } }, "required": [ "headerText", "items" ], "additionalProperties": false, "description": "Configurable content for the trust badge (e.g., badge images, guarantee text)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemSubtitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "itemTitle", "itemSubtitle" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" } }, "required": [ "header", "item", "block" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "itemTitleText": { "type": "string" }, "itemSubtitleText": { "type": "string" } }, "required": [ "headerText", "itemTitleText", "itemSubtitleText" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "rowCount", "columnCount" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "itemBorderThickness": { "type": "string" }, "itemBorderStyle": { "default": "none", "type": "string" }, "itemCornerRadius": { "type": "string" }, "itemTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "itemBorderThickness", "itemBorderStyle", "itemCornerRadius", "itemTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the trust badge appearance." } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "upsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "maxProductLimit": { "default": 3, "type": "integer", "minimum": 1, "maximum": 10 }, "excludeItemsInCart": { "default": false, "type": "boolean" }, "excludeOutOfStock": { "default": false, "type": "boolean" }, "buttonText": { "type": "string" }, "imageSize": { "type": "number", "minimum": 1, "maximum": 500 }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "type": "string" }, "mediaSpacing": { "type": "string" } }, "required": [ "headerText", "maxProductLimit", "excludeItemsInCart", "excludeOutOfStock", "buttonText", "imageSize", "imageSizeUnit", "imageAspectRatio", "mediaSpacing" ], "additionalProperties": false, "description": "Configurable content for the upsell block (e.g., product selection, heading text, CTA label)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "variantTitle": { "default": { "fontSize": "base", "fontStyle": "normal" }, "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "productTitle", "variantTitle", "price", "button" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" }, "button": { "type": "string" }, "productUnit": { "type": "string" } }, "required": [ "header", "item", "block", "button", "productUnit" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "productText": { "type": "string" }, "variantText": { "default": "subdued", "type": "string" }, "priceText": { "type": "string" }, "carouselArrowColor": { "default": "monochrome", "type": "string" }, "carouselArrowStyle": { "default": "primary", "type": "string" } }, "required": [ "headerText", "productText", "variantText", "priceText", "carouselArrowColor", "carouselArrowStyle" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "mobile": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "mobile", "desktop" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "productBorderThickness": { "type": "string" }, "productBorderStyle": { "default": "none", "type": "string" }, "productCornerRadius": { "type": "string" }, "productTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "productBorderThickness", "productBorderStyle", "productCornerRadius", "productTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the upsell block appearance." }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "postPurchaseUpsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "discountType": { "default": "none", "type": "string", "enum": [ "none", "percentage", "fixed" ] }, "discountValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "compareAtPriceDisplay": { "default": "none", "type": "string", "enum": [ "none", "compareAtPrice", "regularPrice" ] }, "imageAspectRatio": { "type": "string" }, "excludeOutOfStock": { "type": "boolean" }, "excludeItemsInCart": { "type": "boolean" }, "maxProductLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bannerEnabled": { "type": "boolean" }, "bannerTitle": { "type": "string" }, "bannerSubtitle": { "type": "string" }, "compareAtPriceEnabled": { "type": "boolean" }, "descriptionEnabled": { "type": "boolean" }, "quantitySelectorEnabled": { "type": "boolean" }, "quantityLabel": { "type": "string" }, "maxQuantityType": { "type": "string" }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "moneyLineEnabled": { "type": "boolean" }, "moneyLineSubtotal": { "type": "boolean" }, "moneyLineShipping": { "type": "boolean" }, "moneyLineTaxes": { "type": "boolean" }, "primaryButtonText": { "type": "string" }, "secondaryButtonEnabled": { "type": "boolean" }, "secondaryButtonText": { "type": "string" }, "headingLevel": { "type": "string" } }, "required": [ "headerText", "discountType", "compareAtPriceDisplay", "imageAspectRatio", "excludeOutOfStock", "excludeItemsInCart", "maxProductLimit", "bannerEnabled", "compareAtPriceEnabled", "descriptionEnabled", "quantitySelectorEnabled", "moneyLineEnabled", "moneyLineSubtotal", "moneyLineShipping", "moneyLineTaxes", "primaryButtonText", "secondaryButtonEnabled", "headingLevel" ], "additionalProperties": false }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "description": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "primaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "secondaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "productTitle", "price", "primaryButton" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "banner": { "type": "string" }, "primaryButton": { "type": "string" }, "secondaryButton": { "type": "string" } }, "required": [ "banner", "primaryButton" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "bannerText": { "type": "string" }, "productText": { "type": "string" }, "priceText": { "type": "string" }, "descriptionText": { "type": "string" }, "primaryButtonText": { "type": "string" }, "secondaryButtonText": { "type": "string" } }, "required": [ "productText", "priceText", "primaryButtonText" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "bannerBorderStyle": { "type": "string" }, "bannerSpacing": { "type": "string" }, "bannerTextAlign": { "type": "string" }, "separatorWidth": { "type": "string" }, "imageFit": { "type": "string" }, "imageBorder": { "type": "boolean" }, "pricingAppearance": { "type": "string" }, "pricingEmphasized": { "type": "boolean" }, "pricingSubduedStyle": { "type": "boolean" }, "descriptionSubdued": { "type": "boolean" }, "secondaryButtonStyle": { "type": "string" } }, "required": [ "bannerBorderStyle", "bannerSpacing", "bannerTextAlign", "separatorWidth", "imageFit", "imageBorder", "pricingEmphasized", "descriptionSubdued", "secondaryButtonStyle" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "appearance" ], "additionalProperties": false }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false } ], "type": "object" } }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false } } }, "required": [ "id", "experienceId", "name", "percentage", "isControl", "order", "onsiteEdits", "functionSyncError" ], "additionalProperties": false } }, "createdAtTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds." }, "isDeleted": { "description": "Whether this experience has been soft-deleted and hidden from default listings.", "type": "boolean" }, "shippingTestMethodDefinitions": { "default": [], "description": "Shipping rate configurations. Only populated for shipping test experiences.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deliveryProfileId": { "type": "string" }, "deliveryLocationGroupId": { "type": "string" }, "deliveryZoneId": { "type": "string" }, "methodDefinitionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canonicalMethodId": { "type": "string" }, "deleteTargetKind": { "type": "string", "enum": [ "canonical_method", "participant_method", "synthetic_free_condition", "synthetic_rate_definition" ] }, "deleteTargetRateDefinitionId": { "type": "string" }, "deleteTargetFreeCondition": { "type": "object", "properties": { "subject": { "type": "string" }, "min": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] } }, "required": [ "subject" ], "additionalProperties": false } }, "required": [ "deliveryProfileId", "deliveryLocationGroupId", "deliveryZoneId" ], "additionalProperties": false } }, "audience": { "description": "Visitor segmentation rules. Null means all visitors are eligible.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "enabled": { "type": "boolean", "description": "When false, audience rules are ignored and all visitors are eligible." }, "excludeCurrency": { "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Whether currency/geo-based exclusion is active." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 4217 currency code to exclude. Null disables currency-based exclusion." }, "country": { "description": "ISO country code to exclude visitors from.", "type": "string" }, "region": { "description": "Region or state code to exclude visitors from.", "type": "string" }, "city": { "description": "City name to exclude visitors from.", "type": "string" } }, "required": [ "exclude", "currency" ], "additionalProperties": false, "description": "Currency and geo-based visitor exclusion configuration." }, "wholesale": { "type": "boolean", "description": "Controls whether wholesale (B2B) customers are included in or excluded from the experience." }, "audienceType": { "description": "Complexity level of the targeting rules: common (prebuilt), custom (simple), or advanced (full expression trees).", "type": "string", "enum": [ "common", "custom", "advanced" ] }, "elseAction": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "Fallback for visitors matching no filter: 'randomVariation' assigns randomly across variations (most common), 'assignVariation' forces a specific variation (set elseVariationId), 'experienceExclude' removes them from the experience entirely, 'leaveUnassigned' skips assignment." }, "elseVariationId": { "description": "Variation to force-assign when elseAction is 'assignVariation'. Typically set to the control variation to default non-targeted visitors to baseline.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "elseExcludeFromAnalytics": { "default": false, "description": "When true, visitors who match no filter are tracked but excluded from analytics calculations.", "type": "boolean" }, "filters": { "default": [], "description": "Ordered filter rules evaluated from lowest priority value first (0-indexed). First matching filter determines visitor treatment.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Evaluation order. 0-indexed. Filters with lower values are evaluated first." }, "action": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly." }, "filterType": { "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ], "description": "Category of targeting rule (e.g., UTM parameters, device type, visitor type)." }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ], "description": "Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both." }, "expressionType": { "description": "Whether this uses prebuilt common rules or custom expression logic.", "anyOf": [ { "type": "string", "enum": [ "common", "custom" ] }, { "type": "null" } ] }, "variationId": { "description": "Variation to assign when action is 'assignVariation'. References a variation in the parent experience.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "excludeFromAnalytics": { "default": false, "description": "When true, visitors matching this filter are excluded from analytics even if included in the experience.", "type": "boolean" } }, "required": [ "id", "priority", "action", "filterType", "excludeFromAnalytics" ], "additionalProperties": false } }, "evaluationFrequency": { "description": "How often (in seconds) to re-evaluate audience rules for a returning visitor. Controls targeting freshness.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "enabled", "excludeCurrency", "wholesale", "elseAction", "elseExcludeFromAnalytics", "filters" ], "additionalProperties": false }, { "type": "null" } ] }, "lastUpdateTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds of the most recent modification." }, "previewPath": { "description": "Storefront URL path used when generating preview links (e.g., '/products/example').", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isExternal": { "description": "True if this experience was created and is managed via the external API rather than the dashboard.", "anyOf": [ { "default": false, "type": "boolean" }, { "type": "null" } ] }, "startedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if never started." }, "pausedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not currently paused." }, "archivedAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not archived.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "requiresLink": { "default": false, "description": "When true, visitors must use a special link to enter the experience instead of being auto-assigned.", "type": "boolean" }, "linkBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Base URL for generating access links. Only populated when requiresLink is true." }, "endedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if still active." }, "productVariantCount": { "default": 0, "description": "Server-generated. Read-only. Total product variants currently included in this experience.", "type": "number" }, "sourceExperienceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Present when this experience was duplicated or rolled out from another. References the original." }, "sourceAction": { "anyOf": [ { "type": "string", "enum": [ "duplicate", "rollout" ] }, { "type": "null" } ], "description": "How this experience was derived from sourceExperienceId. Only present when sourceExperienceId is set." }, "experienceAnalysis": { "type": "object", "properties": { "analyticsViewType": { "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ], "description": "Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted." } }, "required": [ "analyticsViewType" ], "additionalProperties": false } }, "required": [ "id", "name", "isPreview", "organizationId", "type", "category", "status", "testTypes", "experiencePageTargeting", "experienceProductTargeting", "experienceActions", "experienceIntegrations", "experienceCustomMetrics", "experienceKeyMetrics", "variations", "createdAtTs", "shippingTestMethodDefinitions", "lastUpdateTs", "startedAtTs", "pausedAtTs", "requiresLink", "linkBaseUrl", "endedAtTs", "productVariantCount", "experienceAnalysis" ], "additionalProperties": false, "description": "Full single-experience payload returned by GET /experiences/{experienceId}. Includes `experienceCustomMetrics`, `experienceIntegrations`, `experienceKeyMetrics`, and `shippingTestMethodDefinitions`. Unlike GET /experiences-list items, this response does not include `history`." } }, "required": [ "experience" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/experiences-list": { "get": { "tags": [ "Fetch Experience Data" ], "description": "Retrieve a paginated list of experiences.\n\nThe response includes `experiencesList` plus the pagination fields `page`, `limit`, `total`, and `totalPages`.\n\n### Query Parameters\n\nAll query parameters are optional.\n\n- `limit` \u2014 integer, defaults to `20`\n- `page` \u2014 integer (minimum `1`), defaults to `1`\n- `status` \u2014 one of `started`, `paused`, `ended`, `pending`\n- `category` \u2014 one of `experiment`, `personalization`\n\n`offset` is not supported for this endpoint. Pagination is page-based (`page` + `limit`).\n\nEach list item includes `history` \u2014 raw user-action records with broad action types (`saveExperience`, `duplicateExperience`, `archiveCampaign`, etc.) and full user objects. For lifecycle-only events (`start`, `pause`, `end`, `delete`, `reset`) with the performing user's email, see `experienceActions`. For config-deploy diffs, see `?includeChangeLog=true` on `GET /experiences/{experienceId}`.\n\nCompared with `GET /experiences/{experienceId}`, list items do not include `experienceCustomMetrics`, `experienceIntegrations`, `experienceKeyMetrics`, or `shippingTestMethodDefinitions`.", "security": [ { "intelligems_access_token": [] } ], "x-codeSamples": [ { "lang": "Shell", "label": "List all started experiments (paginated)", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/experiences-list?category=experiment&status=started&limit=20&page=1' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data ''" }, { "lang": "Shell", "label": "List the first page of active personalizations", "source": "curl --location 'https://api.intelligems.io/v25-10-beta/experiences-list?category=personalization&status=started&limit=20&page=1' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data ''" } ], "parameters": [ { "in": "query", "name": "category", "schema": { "description": "Filter by experience category. Omit to return all categories.", "type": "string", "enum": [ "experiment", "personalization" ] }, "description": "Filter by experience category. Omit to return all categories." }, { "in": "query", "name": "status", "schema": { "description": "Filter by lifecycle status. Omit to return all statuses.", "type": "string", "enum": [ "pending", "started", "ended", "paused" ] }, "description": "Filter by lifecycle status. Omit to return all statuses." }, { "in": "query", "name": "limit", "schema": { "description": "Maximum number of experiences per page.", "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "description": "Maximum number of experiences per page." }, { "in": "query", "name": "page", "schema": { "description": "1-based page number for paginated results.", "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "description": "1-based page number for paginated results." } ], "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "experiencesList": { "type": "array", "items": { "type": "object", "properties": { "archivedAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not archived.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "audience": { "description": "Visitor segmentation rules. Null means all visitors are eligible.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "enabled": { "type": "boolean", "description": "When false, audience rules are ignored and all visitors are eligible." }, "excludeCurrency": { "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Whether currency/geo-based exclusion is active." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 4217 currency code to exclude. Null disables currency-based exclusion." }, "country": { "description": "ISO country code to exclude visitors from.", "type": "string" }, "region": { "description": "Region or state code to exclude visitors from.", "type": "string" }, "city": { "description": "City name to exclude visitors from.", "type": "string" } }, "required": [ "exclude", "currency" ], "additionalProperties": false, "description": "Currency and geo-based visitor exclusion configuration." }, "wholesale": { "type": "boolean", "description": "Controls whether wholesale (B2B) customers are included in or excluded from the experience." }, "audienceType": { "description": "Complexity level of the targeting rules: common (prebuilt), custom (simple), or advanced (full expression trees).", "type": "string", "enum": [ "common", "custom", "advanced" ] }, "elseAction": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "Fallback for visitors matching no filter: 'randomVariation' assigns randomly across variations (most common), 'assignVariation' forces a specific variation (set elseVariationId), 'experienceExclude' removes them from the experience entirely, 'leaveUnassigned' skips assignment." }, "elseVariationId": { "description": "Variation to force-assign when elseAction is 'assignVariation'. Typically set to the control variation to default non-targeted visitors to baseline.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "elseExcludeFromAnalytics": { "default": false, "description": "When true, visitors who match no filter are tracked but excluded from analytics calculations.", "type": "boolean" }, "filters": { "default": [], "description": "Ordered filter rules evaluated from lowest priority value first (0-indexed). First matching filter determines visitor treatment.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Evaluation order. 0-indexed. Filters with lower values are evaluated first." }, "action": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly." }, "filterType": { "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ], "description": "Category of targeting rule (e.g., UTM parameters, device type, visitor type)." }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ], "description": "Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both." }, "expressionType": { "description": "Whether this uses prebuilt common rules or custom expression logic.", "anyOf": [ { "type": "string", "enum": [ "common", "custom" ] }, { "type": "null" } ] }, "variationId": { "description": "Variation to assign when action is 'assignVariation'. References a variation in the parent experience.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "excludeFromAnalytics": { "default": false, "description": "When true, visitors matching this filter are excluded from analytics even if included in the experience.", "type": "boolean" } }, "required": [ "id", "priority", "action", "filterType", "excludeFromAnalytics" ], "additionalProperties": false } }, "evaluationFrequency": { "description": "How often (in seconds) to re-evaluate audience rules for a returning visitor. Controls targeting freshness.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "enabled", "excludeCurrency", "wholesale", "elseAction", "elseExcludeFromAnalytics", "filters" ], "additionalProperties": false }, { "type": "null" } ] }, "category": { "type": "string", "enum": [ "experiment", "personalization" ], "description": "Distinguishes A/B experiments (statistical testing) from personalization rules (deterministic targeting)." }, "createdAtTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds." }, "currency": { "description": "Currency settings for price display and analytics calculations. Null inherits store default.", "anyOf": [ { "type": "object", "properties": { "code": { "default": "USD", "description": "ISO 4217 currency code used for analytics and price calculations.", "type": "string" }, "country": { "description": "ISO country code for locale-specific formatting.", "type": "string" }, "options": { "description": "Additional locale-specific formatting options." }, "symbol": { "default": "$", "description": "Display symbol prepended to amounts (e.g., '$', '\u20ac').", "type": "string" }, "suffix": { "description": "Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').", "type": "string" } }, "required": [ "code", "symbol" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "description": "Internal note explaining what this experience tests.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "devicePreview": { "description": "Device and path configuration for the preview iframe.", "anyOf": [ { "type": "object", "properties": { "device": { "default": "desktop", "description": "Viewport to simulate when rendering the preview.", "type": "string", "enum": [ "any", "mobile", "desktop" ] }, "path": { "default": "/", "description": "Storefront URL path to load in the preview (e.g., '/products/example').", "type": "string" } }, "required": [ "device", "path" ], "additionalProperties": false, "description": "Device and path configuration for previewing the experience." }, { "type": "null" } ] }, "endedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if still active." }, "experienceActions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string", "enum": [ "start", "pause", "end", "delete", "reset" ] }, "actionTs": { "type": "number" }, "performedBy": { "description": "Email of the user who triggered this lifecycle event. Resolved from History records by matching action type and timestamp within a 5-minute window. Null if no matching History record is found, or if the record has no associated user. Currently only populated by GET /experiences/{experienceId}; list endpoints return null.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "action", "actionTs" ], "additionalProperties": false }, "description": "Server-generated. Read-only. Lifecycle state transitions (start, pause, end, delete, reset) recorded for this experience. On GET /experiences/{experienceId}, each entry includes a `performedBy` field with the triggering user's email, resolved from History records (may be null if unresolvable). Distinct from the list endpoint's raw `history` field, which contains broader user-action records." }, "experiencePageTargeting": { "default": [], "description": "URL rules controlling which storefront pages this experience activates on. Empty means all pages.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filter": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "filterType": { "default": "url", "type": "string", "enum": [ "utm", "url", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie" ] }, "value": { "type": "string" }, "order": { "type": "number" }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "filterType", "value", "order" ], "additionalProperties": false } }, "experienceProductTargeting": { "default": [], "description": "Product attribute rules controlling which products this experience applies to. Empty means all products.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "target": { "type": "string", "enum": [ "productPage", "productCard" ], "description": "Storefront context where targeting rules are evaluated (product detail pages vs collection/search listings)." }, "expression": { "description": "Boolean expression tree of product attribute conditions. Each node has either a 'query' (leaf) or 'operator' (combinator).", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Product attribute to filter on. Determines which product property is evaluated." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Expected value. String for text attributes (productId, collection, tag); number for numeric attributes (price, inventory)." }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan" ], "description": "Comparison operator for evaluating the product attribute against the value." }, "type": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Mirrors the key field. Determines attribute category for validation." } }, "required": [ "key", "value", "filter", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "target" ], "additionalProperties": false } }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "isDeleted": { "description": "Whether this experience has been soft-deleted and hidden from default listings.", "type": "boolean" }, "isExternal": { "description": "True if this experience was created and is managed via the external API rather than the dashboard.", "anyOf": [ { "default": false, "type": "boolean" }, { "type": "null" } ] }, "isPreview": { "default": true, "description": "True while in draft mode. Must be set to false before the experience can be started.", "type": "boolean" }, "lastUpdateTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds of the most recent modification." }, "linkBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Base URL for generating access links. Only populated when requiresLink is true." }, "name": { "type": "string", "description": "Display name shown in dashboards and reports." }, "organizationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only. The Shopify store that owns this experience." }, "pausedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not currently paused." }, "productVariantCount": { "default": 0, "description": "Server-generated. Read-only. Total product variants currently included in this experience.", "type": "number" }, "requiresLink": { "default": false, "description": "When true, visitors must use a special link to enter the experience instead of being auto-assigned.", "type": "boolean" }, "sourceAction": { "anyOf": [ { "type": "string", "enum": [ "duplicate", "rollout" ] }, { "type": "null" } ], "description": "How this experience was derived from sourceExperienceId. Only present when sourceExperienceId is set." }, "sourceExperienceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Present when this experience was duplicated or rolled out from another. References the original." }, "startedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if never started." }, "status": { "type": "string", "enum": [ "pending", "started", "ended", "paused" ], "description": "Server-managed lifecycle state. Transitions via start/pause/end actions: pending -> started -> paused/ended." }, "testTypes": { "type": "object", "properties": { "hasTestPricing": { "type": "boolean", "description": "Server-generated. Read-only. True when price testing is active." }, "hasTestShipping": { "type": "boolean", "description": "Server-generated. Read-only. True when shipping rate testing is active." }, "hasTestCampaign": { "type": "boolean", "description": "Server-generated. Read-only. True when campaign/offer testing is active." }, "hasTestContent": { "type": "boolean", "description": "Server-generated. Read-only. True when any content variation type is enabled." }, "hasTestContentUrl": { "type": "boolean", "description": "Server-generated. Read-only. True when URL redirect variations are in use." }, "hasTestContentAdvanced": { "type": "boolean", "description": "Server-generated. Read-only. True when custom JS/CSS variations are in use." }, "hasTestContentOnsite": { "type": "boolean", "description": "Server-generated. Read-only. True when visual onsite edit variations are in use." }, "hasTestContentTemplate": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify template variations are in use." }, "hasTestContentTheme": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify theme variations are in use." }, "hasTestOnsiteInjections": { "type": "boolean", "description": "Server-generated. Read-only. True when CSS/JS injection variations are in use." }, "hasTestCheckoutBlocks": { "type": "boolean", "description": "Server-generated. Read-only. True when checkout block variations are in use." }, "hasTestPostPurchase": { "type": "boolean", "description": "Server-generated. Read-only. True when post-purchase upsell variations are in use." } }, "required": [ "hasTestPricing", "hasTestShipping", "hasTestCampaign", "hasTestContent", "hasTestContentUrl", "hasTestContentAdvanced", "hasTestContentOnsite", "hasTestContentTemplate", "hasTestContentTheme", "hasTestOnsiteInjections", "hasTestCheckoutBlocks", "hasTestPostPurchase" ], "additionalProperties": false, "description": "Server-generated. Read-only. Flags derived from 'type' indicating which variation capabilities are active." }, "type": { "type": "string", "enum": [ "content/advanced", "content/onsiteEdits", "content/url", "content/theme", "content/template", "personalization", "personalization/offer", "pricing", "shipping", "sitewide", "checkoutBlock", "postPurchase" ], "description": "Determines which variation fields are relevant: content/onsiteEdits for DOM edits, content/advanced for CSS/JS injection, content/url for redirect split tests, content/theme for theme tests, content/template for template tests." }, "history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "userId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "user": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "organizationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "isBlocked": { "type": "boolean" }, "showInfoPopup": { "type": "boolean" }, "userAlerts": { "anyOf": [ { "type": "object", "properties": { "showAnalyticsReleaseDialog": { "default": false, "type": "boolean" }, "showPersonalizationsDialog": { "default": false, "type": "boolean" }, "showPersonalizationMigrateBanner": { "default": false, "type": "boolean" }, "showWrappedDialog": { "type": "boolean" } }, "additionalProperties": false }, { "type": "null" } ] }, "showWelcome": { "default": true, "type": "boolean" }, "preferredName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "preferredEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "installer": { "default": false, "type": "boolean" }, "companyRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "previousExperience": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "email", "organizationId", "isBlocked", "showInfoPopup", "showWelcome", "installer" ], "additionalProperties": false }, { "type": "null" } ] }, "experienceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "action": { "type": "string", "enum": [ "startExperience", "pauseExperience", "endExperience", "saveExperience", "deleteExperience", "enableCampaign", "disableCampaign", "saveCampaign", "archiveCampaign", "confirmIntegration", "duplicateExperience", "rolloutExperience", "archiveExperience", "unArchiveExperience", "resetExperience" ] }, "lastUpdateTs": { "type": "number" }, "createdAtTs": { "type": "number" } }, "required": [ "id", "action", "lastUpdateTs", "createdAtTs" ], "additionalProperties": false } }, "previewPath": { "type": "string" }, "variations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "name": { "type": "string", "description": "Display name (e.g., 'Control', 'Variant A'). Unique within the experience." }, "percentage": { "type": "number", "description": "Traffic allocation weight. All percentages across sibling variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order in the analytics dashboard. 0-indexed." }, "functionSyncError": { "default": false, "description": "Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.", "type": "boolean" }, "testExperienceId": { "description": "Links to another experience for advanced multi-experience configurations.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "offerId": { "description": "Server-generated. Read-only. References the associated offer. Populated when offer is set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "redirects": { "description": "URL redirect rules for content/url experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "group": { "type": "number", "description": "Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "originUrl": { "type": "string", "description": "URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field." }, "destinationUrl": { "description": "Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Key-value pairs appended to the destination URL as query parameters.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ], "additionalProperties": false } }, "skip": { "type": "boolean", "description": "When true, this redirect is temporarily disabled." }, "isThemeTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify themes. Used with content/theme experiences." }, "isTemplateTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify templates. Used with content/template experiences." }, "templateType": { "description": "Shopify template type being tested (e.g., product, collection).", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "When true, the redirect fires only once per visitor session to avoid redirect loops.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "id", "group", "variationId", "originUrl", "queryParams", "skip", "isThemeTest", "isTemplateTest", "templateSuffixes", "redirectOnce", "filter", "redirectType" ], "additionalProperties": false } } }, "required": [ "id", "experienceId", "name", "percentage", "isControl", "order", "functionSyncError" ], "additionalProperties": false } }, "organization": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "shopId": { "type": "string" }, "orderCount": { "type": "number" } }, "required": [ "id", "name", "shopId" ], "additionalProperties": false }, { "type": "null" } ] }, "experienceAnalysis": { "type": "object", "properties": { "analyticsViewType": { "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ], "description": "Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted." } }, "required": [ "analyticsViewType" ], "additionalProperties": false } }, "required": [ "category", "createdAtTs", "endedAtTs", "experienceActions", "experiencePageTargeting", "experienceProductTargeting", "id", "isPreview", "lastUpdateTs", "linkBaseUrl", "name", "organizationId", "pausedAtTs", "productVariantCount", "requiresLink", "startedAtTs", "status", "testTypes", "type", "history", "previewPath", "variations", "experienceAnalysis" ], "additionalProperties": false, "description": "Experience summary item returned by GET /experiences-list. Includes `history` for each item. Does not include `experienceCustomMetrics`, `experienceIntegrations`, `experienceKeyMetrics`, or `shippingTestMethodDefinitions`; those fields are only returned by GET /experiences/{experienceId}." }, "description": "Paginated array of experience summary items." }, "page": { "type": "number", "description": "1-based page number returned for this result set." }, "limit": { "type": "number", "description": "Maximum number of experiences requested per page." }, "total": { "type": "number", "description": "Total number of matching experiences across all pages." }, "totalPages": { "type": "number", "description": "Total number of pages available for the current limit." } }, "required": [ "experiencesList", "page", "limit", "total", "totalPages" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/experiences/{experienceId}": { "get": { "tags": [ "Fetch Experience Data" ], "description": "Retrieve a single experience by ID.\n\nThe response body is wrapped in an `experience` key:\n\n```json\n{\n \"experience\": {\n \"id\": \"YOUR_EXPERIENCE_ID\"\n }\n}\n```\n\nCompared with `GET /experiences-list`, this response includes `experienceCustomMetrics`, `experienceIntegrations`, `experienceKeyMetrics`, and `shippingTestMethodDefinitions`.\n\n### Tracking who changed what\n\nThis endpoint exposes two complementary audit trails:\n\n- **`experienceActions`** (always returned) \u2014 lifecycle state transitions (`start`, `pause`, `end`, `delete`, `reset`). Each entry includes a `performedBy` field with the email of the user who triggered the action, resolved from History records by matching action type and timestamp within a 5-minute window. `performedBy` is `null` when no matching History record is found.\n- **`changeLog`** (opt-in, see `includeChangeLog` below) \u2014 audit trail of deployed-config changes that touched this experience. Each entry groups diffs by entity type (`experience`, `variations`, `offers`, `onsiteEdits`, `onsiteInjections`, `redirects`, `checkoutBlocks`, `audiences`, `pageTargeting`) and carries the deployer's email via `performedBy`. Capped at the 20 most recent entries, newest first.\n\n### Query Parameters\n\nAll query parameters are optional.\n\n- `includeChangeLog` \u2014 boolean, defaults to `false`. When `true`, the response includes a top-level `changeLog` array on the experience.\n\n### Note on `history`\n\nList items on `GET /experiences-list` include a `history` array containing raw user-action records with broader action types (`saveExperience`, `duplicateExperience`, `archiveCampaign`, etc.) and full user objects. The single-experience response does not include this `history` field \u2014 use `experienceActions` for lifecycle events and `?includeChangeLog=true` for config-deploy diffs instead.", "security": [ { "intelligems_access_token": [] } ], "parameters": [ { "in": "path", "name": "experienceId", "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "required": true }, { "in": "query", "name": "includeChangeLog", "schema": { "description": "When true, include a top-level `changeLog` array on the experience containing per-deploy diffs of entities that were modified (experience, variations, offers, onsiteEdits, onsiteInjections, redirects, checkoutBlocks, audiences, pageTargeting). Each entry carries the deployer's email via `performedBy`. Capped at the 20 most recent deploys, newest first. Defaults to false.", "type": "boolean" }, "description": "When true, include a top-level `changeLog` array on the experience containing per-deploy diffs of entities that were modified (experience, variations, offers, onsiteEdits, onsiteInjections, redirects, checkoutBlocks, audiences, pageTargeting). Each entry carries the deployer's email via `performedBy`. Capped at the 20 most recent deploys, newest first. Defaults to false." } ], "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "experience": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "name": { "type": "string", "description": "Display name shown in dashboards and reports." }, "isPreview": { "default": true, "description": "True while in draft mode. Must be set to false before the experience can be started.", "type": "boolean" }, "description": { "description": "Internal note explaining what this experience tests.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "devicePreview": { "description": "Device and path configuration for the preview iframe.", "anyOf": [ { "type": "object", "properties": { "device": { "default": "desktop", "description": "Viewport to simulate when rendering the preview.", "type": "string", "enum": [ "any", "mobile", "desktop" ] }, "path": { "default": "/", "description": "Storefront URL path to load in the preview (e.g., '/products/example').", "type": "string" } }, "required": [ "device", "path" ], "additionalProperties": false, "description": "Device and path configuration for previewing the experience." }, { "type": "null" } ] }, "organizationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only. The Shopify store that owns this experience." }, "type": { "type": "string", "enum": [ "content/advanced", "content/onsiteEdits", "content/url", "content/theme", "content/template", "personalization", "personalization/offer", "pricing", "shipping", "sitewide", "checkoutBlock", "postPurchase" ], "description": "Determines which variation fields are relevant: content/onsiteEdits for DOM edits, content/advanced for CSS/JS injection, content/url for redirect split tests, content/theme for theme tests, content/template for template tests." }, "category": { "type": "string", "enum": [ "experiment", "personalization" ], "description": "Distinguishes A/B experiments (statistical testing) from personalization rules (deterministic targeting)." }, "status": { "type": "string", "enum": [ "pending", "started", "ended", "paused" ], "description": "Server-managed lifecycle state. Transitions via start/pause/end actions: pending -> started -> paused/ended." }, "testTypes": { "type": "object", "properties": { "hasTestPricing": { "type": "boolean", "description": "Server-generated. Read-only. True when price testing is active." }, "hasTestShipping": { "type": "boolean", "description": "Server-generated. Read-only. True when shipping rate testing is active." }, "hasTestCampaign": { "type": "boolean", "description": "Server-generated. Read-only. True when campaign/offer testing is active." }, "hasTestContent": { "type": "boolean", "description": "Server-generated. Read-only. True when any content variation type is enabled." }, "hasTestContentUrl": { "type": "boolean", "description": "Server-generated. Read-only. True when URL redirect variations are in use." }, "hasTestContentAdvanced": { "type": "boolean", "description": "Server-generated. Read-only. True when custom JS/CSS variations are in use." }, "hasTestContentOnsite": { "type": "boolean", "description": "Server-generated. Read-only. True when visual onsite edit variations are in use." }, "hasTestContentTemplate": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify template variations are in use." }, "hasTestContentTheme": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify theme variations are in use." }, "hasTestOnsiteInjections": { "type": "boolean", "description": "Server-generated. Read-only. True when CSS/JS injection variations are in use." }, "hasTestCheckoutBlocks": { "type": "boolean", "description": "Server-generated. Read-only. True when checkout block variations are in use." }, "hasTestPostPurchase": { "type": "boolean", "description": "Server-generated. Read-only. True when post-purchase upsell variations are in use." } }, "required": [ "hasTestPricing", "hasTestShipping", "hasTestCampaign", "hasTestContent", "hasTestContentUrl", "hasTestContentAdvanced", "hasTestContentOnsite", "hasTestContentTemplate", "hasTestContentTheme", "hasTestOnsiteInjections", "hasTestCheckoutBlocks", "hasTestPostPurchase" ], "additionalProperties": false, "description": "Server-generated. Read-only. Flags derived from 'type' indicating which variation capabilities are active." }, "experiencePageTargeting": { "default": [], "description": "URL rules controlling which storefront pages this experience activates on. Empty means all pages.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filter": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "filterType": { "default": "url", "type": "string", "enum": [ "utm", "url", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie" ] }, "value": { "type": "string" }, "order": { "type": "number" }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "filterType", "value", "order" ], "additionalProperties": false } }, "experienceProductTargeting": { "default": [], "description": "Product attribute rules controlling which products this experience applies to. Empty means all products.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "target": { "type": "string", "enum": [ "productPage", "productCard" ], "description": "Storefront context where targeting rules are evaluated (product detail pages vs collection/search listings)." }, "expression": { "description": "Boolean expression tree of product attribute conditions. Each node has either a 'query' (leaf) or 'operator' (combinator).", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Product attribute to filter on. Determines which product property is evaluated." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Expected value. String for text attributes (productId, collection, tag); number for numeric attributes (price, inventory)." }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan" ], "description": "Comparison operator for evaluating the product attribute against the value." }, "type": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Mirrors the key field. Determines attribute category for validation." } }, "required": [ "key", "value", "filter", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "target" ], "additionalProperties": false } }, "experienceActions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string", "enum": [ "start", "pause", "end", "delete", "reset" ] }, "actionTs": { "type": "number" }, "performedBy": { "description": "Email of the user who triggered this lifecycle event. Resolved from History records by matching action type and timestamp within a 5-minute window. Null if no matching History record is found, or if the record has no associated user. Currently only populated by GET /experiences/{experienceId}; list endpoints return null.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "action", "actionTs" ], "additionalProperties": false }, "description": "Server-generated. Read-only. Lifecycle state transitions (start, pause, end, delete, reset) recorded for this experience. On GET /experiences/{experienceId}, each entry includes a `performedBy` field with the triggering user's email, resolved from History records (may be null if unresolvable). Distinct from the list endpoint's raw `history` field, which contains broader user-action records." }, "experienceIntegrations": { "default": [], "description": "Connected third-party integrations (e.g., Google Analytics, Segment).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAtTs": { "type": "number" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "enum": [ "Recharge", "StayAi", "GrowLTV", "OneClickUpsell", "Google", "Amped", "Clarity", "Hotjar", "Heatmap", "CustomApi", "Klaviyo", "Slack", "Amplitude", "Heap", "Segment", "IntelligemsAPI", "IntelligemsMcp" ] }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "globalSettings": {}, "apis": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessToken": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "read_experiments", "write_experiments", "write_test_groups", "read_integrations" ] } }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "name", "accessToken", "scopes", "organization" ], "additionalProperties": false } }, "createdAtTs": { "type": "number" }, "lastUpdateTs": { "type": "number" } }, "required": [ "id", "name", "description", "enabled", "globalSettings", "apis" ], "additionalProperties": false }, "experienceSettings": {}, "enabled": { "default": false, "type": "boolean" } }, "required": [ "id", "createdAtTs", "integration", "experienceSettings", "enabled" ], "additionalProperties": false } }, "experienceCustomMetrics": { "default": [], "description": "Custom event-based metrics tracked alongside standard key metrics.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "number", "description": "Display position in the analytics dashboard. 0-indexed." }, "customEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the custom event definition configured in the organization's analytics settings." }, "customEvent": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "pageView" }, "settings": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "productPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "handle": { "type": "string" } }, "required": [ "productId", "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "collectionPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "handle": { "type": "string" } }, "required": [ "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "clickEvent" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "elementViewed" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "scrollDepth" }, "settings": { "type": "object", "properties": { "mobile": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false } }, "required": [ "mobile", "desktop" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptEvent" }, "settings": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptImportedEvent" }, "settings": { "type": "object", "properties": { "registered": { "type": "boolean" } }, "required": [ "registered" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false } ], "description": "Server-generated. Read-only. Expanded custom event definition with name, tracking details, and configuration.", "type": "object" } }, "required": [ "id", "experienceId", "order", "customEventId", "customEvent" ], "additionalProperties": false } }, "experienceKeyMetrics": { "default": [], "description": "Business metrics (revenue, conversion, AOV, etc.) used to evaluate test performance. One must be primary.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display position in the analytics dashboard. 0-indexed." }, "isPrimary": { "default": false, "description": "The primary metric determines the main success signal for the test. Exactly one per experience.", "type": "boolean" }, "standardEventId": { "description": "Standard e-commerce event (e.g., revenue, conversion). Mutually exclusive with experienceCustomMetricId.", "anyOf": [ { "type": "string", "enum": [ "conversionRate", "addToCartRate", "abandonedCartRate", "abandonedCheckoutRate", "checkoutBeginRate", "checkoutEnterContactInfoRate", "checkoutAddressSubmittedRate", "viewProductPageRate", "viewCollectionPageRate", "netRevenuePerVisitor", "netProductRevenuePerOrder", "netRevenuePerOrder", "avgUnitsPerOrder", "avgProductRevenuePerUnit", "profitPerVisitor", "profitPerOrder", "pctOrdersFreeShipping", "netShippingRevenuePerOrder", "subscriptionOrdersPerVisitor", "subscriptionRevenuePerVisitor", "subscriptionProfitPerVisitor", "subscriptionProductRevenuePerOrder", "avgDiscountPerDiscountedOrder", "avgDiscountPerAllOrders", "pctSubscriptionOrders", "subscriptionRevenuePerOrder" ] }, { "type": "null" } ] }, "experienceCustomMetricId": { "description": "References a custom event metric. Mutually exclusive with standardEventId. Exactly one of these must be set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "order", "isPrimary" ], "additionalProperties": false } }, "currency": { "description": "Currency settings for price display and analytics calculations. Null inherits store default.", "anyOf": [ { "type": "object", "properties": { "code": { "default": "USD", "description": "ISO 4217 currency code used for analytics and price calculations.", "type": "string" }, "country": { "description": "ISO country code for locale-specific formatting.", "type": "string" }, "options": { "description": "Additional locale-specific formatting options." }, "symbol": { "default": "$", "description": "Display symbol prepended to amounts (e.g., '$', '\u20ac').", "type": "string" }, "suffix": { "description": "Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').", "type": "string" } }, "required": [ "code", "symbol" ], "additionalProperties": false }, { "type": "null" } ] }, "variations": { "default": [], "description": "Test variants including the control. One must be control; traffic percentages must sum to 100.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "name": { "type": "string", "description": "Display name (e.g., 'Control', 'Variant A'). Unique within the experience." }, "percentage": { "type": "number", "description": "Traffic allocation weight. All percentages across sibling variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order in the analytics dashboard. 0-indexed." }, "priceChange": { "description": "Price adjustment amount for pricing-type experiences. Positive increases price, negative discounts. Use priceChange for simple price A/B tests; use offer for structured discount campaigns (tiered, BOGO, free shipping).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priceChangeUnit": { "description": "How priceChange is applied: as a percentage of the original price or a fixed monetary amount.", "anyOf": [ { "type": "string", "enum": [ "percent", "dollar" ] }, { "type": "null" } ] }, "priceRoundingType": { "description": "Rounding strategy applied after priceChange (e.g., round up, round down, charm pricing).", "anyOf": [ { "type": "string", "enum": [ "none", "nearest", "up", "down" ] }, { "type": "null" } ] }, "priceRoundingAmount": { "description": "Target value for rounding (e.g., 0.99 for charm pricing like $X.99).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onsiteEdits": { "default": [], "description": "DOM content modifications (text, HTML, image swaps, element removal). For CSS styling changes, use onsiteInjections instead.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "onsiteEditType": { "description": "Content modification strategy (html, text, image, or hide).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to locate on the page. Interpreted as regex when isRegex is true." }, "title": { "description": "Dashboard label for identifying this edit.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "When true, 'find' is treated as a regular expression.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content. Interpretation depends on onsiteEditType: HTML markup, plain text, or image URL.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping which DOM elements this edit targets (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "When true, this edit is temporarily disabled without being deleted.", "type": "boolean" }, "remove": { "default": false, "description": "When true, the matched element is removed from the DOM instead of having its content replaced.", "type": "boolean" }, "groupId": { "description": "Groups related edits together so they can be managed as a unit.", "type": "string" }, "isHtml": { "default": false, "type": "boolean" }, "isImage": { "default": false, "type": "boolean" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to the target (beforebegin, afterbegin, beforeend, afterend). Null means content replacement." }, "createdAtUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Server-generated. Read-only. Storefront URL where this edit was originally created via the visual editor." }, "createdAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname for locating images to replace. When set, images are found by URL match; when null, querySelectors is used instead." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "find", "isRegex", "replace", "querySelectors", "skip", "remove", "isHtml", "isImage", "insertType" ], "additionalProperties": false } }, "onsiteInjections": { "description": "CSS styling and custom JS injection. At most one per variation. For DOM content changes (text, images, HTML), use onsiteEdits instead.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "type" ], "additionalProperties": false, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "jsInjectionMode" ], "additionalProperties": false }, { "type": "null" } ] }, "offer": { "description": "Structured discount configuration (tiered volume discounts, cart-level discounts, gift-with-purchase, free shipping). Use offer for campaign/discount experiences; use priceChange for simple price A/B tests.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation this offer belongs to." }, "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "description": "Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "minimumUnits": { "default": 1, "type": "number" }, "maximumUnits": { "default": 1, "type": "number" }, "unitDiscount": { "default": 1, "type": "number" }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "minimumUnits", "maximumUnits", "unitDiscount", "discountTitle", "giftWithPurchaseTitle", "isFreeShipping", "isGiftWithPurchase", "autoAddGiftWithPurchase" ], "additionalProperties": false } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ], "additionalProperties": false } } }, "required": [ "type", "rules" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ], "additionalProperties": false }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] } }, "required": [ "id", "variationId", "enabled", "isTest", "isArchived", "name", "unitType", "discountType", "tiers", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount", "requireSameItem", "subscriptionApplicationType" ], "additionalProperties": false }, { "type": "null" } ] }, "offerId": { "description": "Server-generated. Read-only. References the associated offer. Populated when offer is set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "shippingRateGroups": { "description": "Shipping rate overrides. Only populated for shipping test experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupType": { "type": "string", "enum": [ "flatRate", "flatRateWithThreshold", "thresholdOnly", "tieredByPriceOrWeight", "custom" ] }, "position": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "amount": { "type": "number" }, "rateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rateType": { "type": "string", "enum": [ "amount", "threshold", "tier" ] }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SRD", "STD", "SZL", "THB", "TJS", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "min": { "default": 0, "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "conditionType": { "type": "string", "enum": [ "currency", "weight" ] }, "unit": { "anyOf": [ { "type": "string", "enum": [ "g", "kg", "lb", "oz" ] }, { "type": "null" } ] } }, "required": [ "min", "conditionType" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "amount", "rateType", "currency" ], "additionalProperties": false } }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "groupType", "position", "rates", "variationId" ], "additionalProperties": false } }, "excludeProducts": { "description": "When true, specific products are excluded from price changes. Use excludeProducts when most products should be tested and only a few excluded. Mutually exclusive with includeProducts.", "default": false, "type": "boolean" }, "includeProducts": { "description": "When true, only specific products receive price changes. Use includeProducts when only a few products should be tested. Mutually exclusive with excludeProducts.", "default": false, "type": "boolean" }, "testExperienceId": { "description": "Links to another experience for advanced multi-experience configurations.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "functionSyncError": { "default": false, "description": "Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.", "type": "boolean" }, "redirects": { "description": "URL redirect rules for content/url experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "group": { "type": "number", "description": "Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "originUrl": { "type": "string", "description": "URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field." }, "destinationUrl": { "description": "Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Key-value pairs appended to the destination URL as query parameters.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ], "additionalProperties": false } }, "skip": { "type": "boolean", "description": "When true, this redirect is temporarily disabled." }, "isThemeTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify themes. Used with content/theme experiences." }, "isTemplateTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify templates. Used with content/template experiences." }, "templateType": { "description": "Shopify template type being tested (e.g., product, collection).", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "When true, the redirect fires only once per visitor session to avoid redirect loops.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "id", "group", "variationId", "originUrl", "queryParams", "skip", "isThemeTest", "isTemplateTest", "templateSuffixes", "redirectOnce", "filter", "redirectType" ], "additionalProperties": false } }, "userInterfaces": { "description": "UI widget configurations displayed for this variation.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "isEnabled": { "type": "boolean" }, "isArchived": { "default": false, "type": "boolean" }, "widget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "enabledSitewide": { "default": false, "type": "boolean" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "widgetType": { "type": "string", "enum": [ "messageBoxPopup", "messageBoxSlideOut", "quantityButtons", "discountProgressBar", "shippingProgressBar" ] }, "config": { "type": "object", "properties": { "desktop": {}, "mobile": {} }, "additionalProperties": false } }, "required": [ "id", "name", "enabledSitewide", "widgetType", "config" ], "additionalProperties": false }, "widgetId": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "quantityButtons", "progressBar", "messageBox" ] }, "variationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "desktopVariables": { "anyOf": [ {}, { "type": "null" } ] }, "mobileVariables": { "anyOf": [ {}, { "type": "null" } ] }, "styleOverrides": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "id", "isArchived", "widgetId" ], "additionalProperties": false } }, "checkoutBlocks": { "description": "Shopify checkout extensibility block configurations for this variation.", "default": [], "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "trustBadge" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconSize": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageSize": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 500 }, { "type": "null" } ] }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaSpacing": { "type": "string" } }, "required": [ "order", "type", "imageSize", "imageSizeUnit", "mediaSpacing" ], "additionalProperties": false } } }, "required": [ "headerText", "items" ], "additionalProperties": false, "description": "Configurable content for the trust badge (e.g., badge images, guarantee text)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemSubtitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "itemTitle", "itemSubtitle" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" } }, "required": [ "header", "item", "block" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "itemTitleText": { "type": "string" }, "itemSubtitleText": { "type": "string" } }, "required": [ "headerText", "itemTitleText", "itemSubtitleText" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "rowCount", "columnCount" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "itemBorderThickness": { "type": "string" }, "itemBorderStyle": { "default": "none", "type": "string" }, "itemCornerRadius": { "type": "string" }, "itemTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "itemBorderThickness", "itemBorderStyle", "itemCornerRadius", "itemTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the trust badge appearance." } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "upsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "maxProductLimit": { "default": 3, "type": "integer", "minimum": 1, "maximum": 10 }, "excludeItemsInCart": { "default": false, "type": "boolean" }, "excludeOutOfStock": { "default": false, "type": "boolean" }, "buttonText": { "type": "string" }, "imageSize": { "type": "number", "minimum": 1, "maximum": 500 }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "type": "string" }, "mediaSpacing": { "type": "string" } }, "required": [ "headerText", "maxProductLimit", "excludeItemsInCart", "excludeOutOfStock", "buttonText", "imageSize", "imageSizeUnit", "imageAspectRatio", "mediaSpacing" ], "additionalProperties": false, "description": "Configurable content for the upsell block (e.g., product selection, heading text, CTA label)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "variantTitle": { "default": { "fontSize": "base", "fontStyle": "normal" }, "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "productTitle", "variantTitle", "price", "button" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" }, "button": { "type": "string" }, "productUnit": { "type": "string" } }, "required": [ "header", "item", "block", "button", "productUnit" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "productText": { "type": "string" }, "variantText": { "default": "subdued", "type": "string" }, "priceText": { "type": "string" }, "carouselArrowColor": { "default": "monochrome", "type": "string" }, "carouselArrowStyle": { "default": "primary", "type": "string" } }, "required": [ "headerText", "productText", "variantText", "priceText", "carouselArrowColor", "carouselArrowStyle" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "mobile": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "mobile", "desktop" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "productBorderThickness": { "type": "string" }, "productBorderStyle": { "default": "none", "type": "string" }, "productCornerRadius": { "type": "string" }, "productTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "productBorderThickness", "productBorderStyle", "productCornerRadius", "productTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the upsell block appearance." }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "postPurchaseUpsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "discountType": { "default": "none", "type": "string", "enum": [ "none", "percentage", "fixed" ] }, "discountValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "compareAtPriceDisplay": { "default": "none", "type": "string", "enum": [ "none", "compareAtPrice", "regularPrice" ] }, "imageAspectRatio": { "type": "string" }, "excludeOutOfStock": { "type": "boolean" }, "excludeItemsInCart": { "type": "boolean" }, "maxProductLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bannerEnabled": { "type": "boolean" }, "bannerTitle": { "type": "string" }, "bannerSubtitle": { "type": "string" }, "compareAtPriceEnabled": { "type": "boolean" }, "descriptionEnabled": { "type": "boolean" }, "quantitySelectorEnabled": { "type": "boolean" }, "quantityLabel": { "type": "string" }, "maxQuantityType": { "type": "string" }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "moneyLineEnabled": { "type": "boolean" }, "moneyLineSubtotal": { "type": "boolean" }, "moneyLineShipping": { "type": "boolean" }, "moneyLineTaxes": { "type": "boolean" }, "primaryButtonText": { "type": "string" }, "secondaryButtonEnabled": { "type": "boolean" }, "secondaryButtonText": { "type": "string" }, "headingLevel": { "type": "string" } }, "required": [ "headerText", "discountType", "compareAtPriceDisplay", "imageAspectRatio", "excludeOutOfStock", "excludeItemsInCart", "maxProductLimit", "bannerEnabled", "compareAtPriceEnabled", "descriptionEnabled", "quantitySelectorEnabled", "moneyLineEnabled", "moneyLineSubtotal", "moneyLineShipping", "moneyLineTaxes", "primaryButtonText", "secondaryButtonEnabled", "headingLevel" ], "additionalProperties": false }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "description": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "primaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "secondaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "productTitle", "price", "primaryButton" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "banner": { "type": "string" }, "primaryButton": { "type": "string" }, "secondaryButton": { "type": "string" } }, "required": [ "banner", "primaryButton" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "bannerText": { "type": "string" }, "productText": { "type": "string" }, "priceText": { "type": "string" }, "descriptionText": { "type": "string" }, "primaryButtonText": { "type": "string" }, "secondaryButtonText": { "type": "string" } }, "required": [ "productText", "priceText", "primaryButtonText" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "bannerBorderStyle": { "type": "string" }, "bannerSpacing": { "type": "string" }, "bannerTextAlign": { "type": "string" }, "separatorWidth": { "type": "string" }, "imageFit": { "type": "string" }, "imageBorder": { "type": "boolean" }, "pricingAppearance": { "type": "string" }, "pricingEmphasized": { "type": "boolean" }, "pricingSubduedStyle": { "type": "boolean" }, "descriptionSubdued": { "type": "boolean" }, "secondaryButtonStyle": { "type": "string" } }, "required": [ "bannerBorderStyle", "bannerSpacing", "bannerTextAlign", "separatorWidth", "imageFit", "imageBorder", "pricingEmphasized", "descriptionSubdued", "secondaryButtonStyle" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "appearance" ], "additionalProperties": false }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false } ], "type": "object" } }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false } } }, "required": [ "id", "experienceId", "name", "percentage", "isControl", "order", "onsiteEdits", "functionSyncError" ], "additionalProperties": false } }, "createdAtTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds." }, "isDeleted": { "description": "Whether this experience has been soft-deleted and hidden from default listings.", "type": "boolean" }, "shippingTestMethodDefinitions": { "default": [], "description": "Shipping rate configurations. Only populated for shipping test experiences.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deliveryProfileId": { "type": "string" }, "deliveryLocationGroupId": { "type": "string" }, "deliveryZoneId": { "type": "string" }, "methodDefinitionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canonicalMethodId": { "type": "string" }, "deleteTargetKind": { "type": "string", "enum": [ "canonical_method", "participant_method", "synthetic_free_condition", "synthetic_rate_definition" ] }, "deleteTargetRateDefinitionId": { "type": "string" }, "deleteTargetFreeCondition": { "type": "object", "properties": { "subject": { "type": "string" }, "min": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] } }, "required": [ "subject" ], "additionalProperties": false } }, "required": [ "deliveryProfileId", "deliveryLocationGroupId", "deliveryZoneId" ], "additionalProperties": false } }, "audience": { "description": "Visitor segmentation rules. Null means all visitors are eligible.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "enabled": { "type": "boolean", "description": "When false, audience rules are ignored and all visitors are eligible." }, "excludeCurrency": { "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Whether currency/geo-based exclusion is active." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 4217 currency code to exclude. Null disables currency-based exclusion." }, "country": { "description": "ISO country code to exclude visitors from.", "type": "string" }, "region": { "description": "Region or state code to exclude visitors from.", "type": "string" }, "city": { "description": "City name to exclude visitors from.", "type": "string" } }, "required": [ "exclude", "currency" ], "additionalProperties": false, "description": "Currency and geo-based visitor exclusion configuration." }, "wholesale": { "type": "boolean", "description": "Controls whether wholesale (B2B) customers are included in or excluded from the experience." }, "audienceType": { "description": "Complexity level of the targeting rules: common (prebuilt), custom (simple), or advanced (full expression trees).", "type": "string", "enum": [ "common", "custom", "advanced" ] }, "elseAction": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "Fallback for visitors matching no filter: 'randomVariation' assigns randomly across variations (most common), 'assignVariation' forces a specific variation (set elseVariationId), 'experienceExclude' removes them from the experience entirely, 'leaveUnassigned' skips assignment." }, "elseVariationId": { "description": "Variation to force-assign when elseAction is 'assignVariation'. Typically set to the control variation to default non-targeted visitors to baseline.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "elseExcludeFromAnalytics": { "default": false, "description": "When true, visitors who match no filter are tracked but excluded from analytics calculations.", "type": "boolean" }, "filters": { "default": [], "description": "Ordered filter rules evaluated from lowest priority value first (0-indexed). First matching filter determines visitor treatment.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Evaluation order. 0-indexed. Filters with lower values are evaluated first." }, "action": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly." }, "filterType": { "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ], "description": "Category of targeting rule (e.g., UTM parameters, device type, visitor type)." }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ], "description": "Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both." }, "expressionType": { "description": "Whether this uses prebuilt common rules or custom expression logic.", "anyOf": [ { "type": "string", "enum": [ "common", "custom" ] }, { "type": "null" } ] }, "variationId": { "description": "Variation to assign when action is 'assignVariation'. References a variation in the parent experience.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "excludeFromAnalytics": { "default": false, "description": "When true, visitors matching this filter are excluded from analytics even if included in the experience.", "type": "boolean" } }, "required": [ "id", "priority", "action", "filterType", "excludeFromAnalytics" ], "additionalProperties": false } }, "evaluationFrequency": { "description": "How often (in seconds) to re-evaluate audience rules for a returning visitor. Controls targeting freshness.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "enabled", "excludeCurrency", "wholesale", "elseAction", "elseExcludeFromAnalytics", "filters" ], "additionalProperties": false }, { "type": "null" } ] }, "lastUpdateTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds of the most recent modification." }, "previewPath": { "description": "Storefront URL path used when generating preview links (e.g., '/products/example').", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isExternal": { "description": "True if this experience was created and is managed via the external API rather than the dashboard.", "anyOf": [ { "default": false, "type": "boolean" }, { "type": "null" } ] }, "startedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if never started." }, "pausedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not currently paused." }, "archivedAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not archived.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "requiresLink": { "default": false, "description": "When true, visitors must use a special link to enter the experience instead of being auto-assigned.", "type": "boolean" }, "linkBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Base URL for generating access links. Only populated when requiresLink is true." }, "endedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if still active." }, "productVariantCount": { "default": 0, "description": "Server-generated. Read-only. Total product variants currently included in this experience.", "type": "number" }, "sourceExperienceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Present when this experience was duplicated or rolled out from another. References the original." }, "sourceAction": { "anyOf": [ { "type": "string", "enum": [ "duplicate", "rollout" ] }, { "type": "null" } ], "description": "How this experience was derived from sourceExperienceId. Only present when sourceExperienceId is set." }, "experienceAnalysis": { "type": "object", "properties": { "analyticsViewType": { "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ], "description": "Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted." } }, "required": [ "analyticsViewType" ], "additionalProperties": false }, "changeLog": { "description": "Deployed-config change log. Present only when ?includeChangeLog=true. One entry per config deploy that modified this experience, newest first.", "type": "array", "items": { "type": "object", "properties": { "actionTs": { "type": "number" }, "performedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "change": { "type": "object", "properties": { "experience": { "description": "Diff of the experience object itself. Example `changedFields`: `name`, `status`, `description`, `startedAtTs`.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false }, { "type": "null" } ] }, "variations": { "description": "Diffs of variations on this experience. Example `changedFields`: `name`, `percentage`, `isControl`, `order`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] }, "offers": { "description": "Diffs of offers on this experience's variations. Example `changedFields`: `name`, `enabled`, `discountType`, `isArchived`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] }, "onsiteEdits": { "description": "Diffs of onsite edits (DOM/text replacements) on this experience's variations. Example `changedFields`: `find`, `replace`, `title`, `isHtml`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] }, "onsiteInjections": { "description": "Diffs of CSS/JS injections on this experience's variations. Example `changedFields`: `customCss`, `customJs`, `jsInjectionMode`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] }, "redirects": { "description": "Diffs of URL/theme/template redirects on this experience's variations. Example `changedFields`: `originUrl`, `destinationUrl`, `filter`, `redirectType`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] }, "checkoutBlocks": { "description": "Diffs of checkout blocks (trust badges, upsells) on this experience's variations. Example `changedFields`: `blockType`, `variables`, `styles`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] }, "audiences": { "description": "Diffs of audience targeting rules on this experience. Example `changedFields`: `enabled`, `audienceType`, `filters`, `excludeCurrency`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] }, "pageTargeting": { "description": "Diffs of page targeting rules on this experience. Example `changedFields`: `filterType`, `value`, `order`, `expression`.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable identifier of the entity. Matches `previous.id` and `updated.id` when both are present." }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "Top-level field names on this entity that changed (shallow \u2014 nested edits surface as the parent key). Use `changedFields.includes(\"status\")` to detect specific edits, then read `previous`/`updated` for before/after values." }, "previous": { "description": "Snapshot of the entity before the deploy. `null` if the entity was created in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "updated": { "description": "Snapshot of the entity after the deploy. `null` if the entity was deleted in this deploy.", "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "id", "changedFields" ], "additionalProperties": false } }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "actionTs", "change" ], "additionalProperties": false } } }, "required": [ "id", "name", "isPreview", "organizationId", "type", "category", "status", "testTypes", "experiencePageTargeting", "experienceProductTargeting", "experienceActions", "experienceIntegrations", "experienceCustomMetrics", "experienceKeyMetrics", "variations", "createdAtTs", "shippingTestMethodDefinitions", "lastUpdateTs", "startedAtTs", "pausedAtTs", "requiresLink", "linkBaseUrl", "endedAtTs", "productVariantCount", "experienceAnalysis" ], "additionalProperties": false, "description": "Single experience object." } }, "required": [ "experience" ], "additionalProperties": false } } } } } }, "put": { "tags": [ "Update Experience" ], "description": "Updates an existing experience by ID. This is a full PUT replacement \u2014 the entire experience configuration is replaced with the provided data.\n\nAll required fields must be included in every request. Any optional fields omitted will be reset to their defaults.\n\n### Required Fields (inside `experience`)\n\n- `id` (UUID) \u2014 ID of the experience to update\n- `name` (string) \u2014 Name of the experience\n- `type` (string) \u2014 One of: `\"content/advanced\"`, `\"content/onsiteEdits\"`, `\"content/url\"`, `\"content/theme\"`, `\"content/template\"`\n- `experienceAnalysis` \u2014 Analysis configuration (includes `analyticsViewType`)\n- `variations` \u2014 Array of variation objects. Each variation must include its `id`.\n- `experienceKeyMetrics` \u2014 Array of key metric objects. Each must include its `id`.\n\n### Optional Fields (inside `experience`)\n\n- `description` (string) \u2014 Description of the experience\n- `currency` \u2014 Currency display settings\n- `previewPath` (string) \u2014 URL path for previewing\n- `audience` \u2014 Audience targeting rules (must include `id` if provided)\n- `experiencePageTargeting` \u2014 Array of page targeting rules (each must include `id`)\n\n### Important Notes\n\n- The experience must exist and belong to your organization\n- Updating a running experience may affect active visitors\n- Variation weights must sum to 100\n- All nested entities (variations, key metrics, page targeting, audience) must include their `id` field", "security": [ { "intelligems_access_token": [] } ], "x-codeSamples": [ { "lang": "Shell", "label": "Update traffic allocation", "source": "curl --location --request PUT 'https://api.intelligems.io/v25-10-beta/experiences/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"experience\": {\n \"id\": \"a1a1a1a1-a1a1-1111-aaaa-aa1111111111\",\n \"name\": \"Theme Test - NEW\",\n \"type\": \"content/theme\",\n \"experienceAnalysis\": {\n \"analyticsViewType\": \"none\"\n },\n \"variations\": [\n {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"name\": \"Control test-data\",\n \"percentage\": 60,\n \"isControl\": true,\n \"order\": 1,\n \"redirects\": [\n {\n \"id\": \"a1111111-a111-1111-a111-a11111111111\",\n \"variationId\": \"11111111-1111-1111-1111-111111111111\",\n \"group\": 1,\n \"originUrl\": \"https://jerica-plus-store.myshopify.com\",\n \"destinationUrl\": \"https://jerica-plus-store.myshopify.com/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068324949\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n },\n {\n \"id\": \"aaaaaaaa-aaaa-1aaa-aaaa-aaaaaaaaaaaa\",\n \"name\": \"Variant - debut-vintage-theme\",\n \"percentage\": 40,\n \"isControl\": false,\n \"order\": 2,\n \"redirects\": [\n {\n \"id\": \"1aaaaaaa-1aaa-1aaa-1aaa-1aaaaaaaaaaa\",\n \"variationId\": \"aaaaaaaa-aaaa-1aaa-aaaa-aaaaaaaaaaaa\",\n \"group\": 1,\n \"originUrl\": \"https://jerica-plus-store.myshopify.com\",\n \"destinationUrl\": \"https://jerica-plus-store.myshopify.com/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068292181\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n }\n ]\n }\n}'" }, { "lang": "Shell", "label": "Change the variant theme", "source": "curl --location --request PUT 'https://api.intelligems.io/v25-10-beta/experiences/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"experience\": {\n \"id\": \"a1a1a1a1-a1a1-1111-aaaa-aa1111111111\",\n \"name\": \"Theme Test - NEW\",\n \"type\": \"content/theme\",\n \"experienceAnalysis\": {\n \"analyticsViewType\": \"none\"\n },\n \"variations\": [\n {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"name\": \"Control test-data\",\n \"percentage\": 25,\n \"isControl\": true,\n \"order\": 1,\n \"redirects\": [\n {\n \"id\": \"a1111111-a111-1111-a111-a11111111111\",\n \"variationId\": \"11111111-1111-1111-1111-111111111111\",\n \"group\": 1,\n \"originUrl\": \"https://jerica-plus-store.myshopify.com\",\n \"destinationUrl\": \"https://jerica-plus-store.myshopify.com/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068324949\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n },\n {\n \"id\": \"aaaaaaaa-aaaa-1aaa-aaaa-aaaaaaaaaaaa\",\n \"name\": \"Variant - Horizon\",\n \"percentage\": 75,\n \"isControl\": false,\n \"order\": 2,\n \"redirects\": [\n {\n \"id\": \"1aaaaaaa-1aaa-1aaa-1aaa-1aaaaaaaaaaa\",\n \"variationId\": \"aaaaaaaa-aaaa-1aaa-aaaa-aaaaaaaaaaaa\",\n \"group\": 1,\n \"originUrl\": \"https://jerica-plus-store.myshopify.com\",\n \"destinationUrl\": \"https://jerica-plus-store.myshopify.com/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068259413\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n }\n ]\n }\n}'" }, { "lang": "Shell", "label": "Add audience targeting", "source": "curl --location --request PUT 'https://api.intelligems.io/v25-10-beta/experiences/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \\\n--header 'content-type: application/json' \\\n--header 'intelligems-access-token: YOUR_API_KEY' \\\n--data '{\n \"experience\": {\n \"id\": \"a1a1a1a1-a1a1-1111-aaaa-aa1111111111\",\n \"name\": \"Theme Test - NEW\",\n \"type\": \"content/theme\",\n \"experienceAnalysis\": {\n \"analyticsViewType\": \"none\"\n },\n \"variations\": [\n {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"name\": \"Control test-data\",\n \"percentage\": 25,\n \"isControl\": true,\n \"order\": 1,\n \"redirects\": [\n {\n \"id\": \"a1111111-a111-1111-a111-a11111111111\",\n \"variationId\": \"11111111-1111-1111-1111-111111111111\",\n \"group\": 1,\n \"originUrl\": \"https://jerica-plus-store.myshopify.com\",\n \"destinationUrl\": \"https://jerica-plus-store.myshopify.com/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068324949\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n },\n {\n \"id\": \"aaaaaaaa-aaaa-1aaa-aaaa-aaaaaaaaaaaa\",\n \"name\": \"Variant - Horizon\",\n \"percentage\": 75,\n \"isControl\": false,\n \"order\": 2,\n \"redirects\": [\n {\n \"id\": \"1aaaaaaa-1aaa-1aaa-1aaa-1aaaaaaaaaaa\",\n \"variationId\": \"aaaaaaaa-aaaa-1aaa-aaaa-aaaaaaaaaaaa\",\n \"group\": 1,\n \"originUrl\": \"https://jerica-plus-store.myshopify.com\",\n \"destinationUrl\": \"https://jerica-plus-store.myshopify.com/\",\n \"queryParams\": [\n {\n \"key\": \"preview_theme_id\",\n \"value\": \"133068259413\"\n }\n ],\n \"filter\": \"matchesExactly\",\n \"redirectType\": \"fullReplacement\",\n \"redirectOnce\": false,\n \"skip\": false,\n \"isThemeTest\": true,\n \"isTemplateTest\": false\n }\n ]\n }\n ],\n \"audience\": {\n \"id\": \"a1a1a1a1-1a1a-1a1a-a1a1-1a1a1a1a1a1a\",\n \"enabled\": true,\n \"audienceType\": \"common\",\n \"elseAction\": \"experienceExclude\",\n \"elseExcludeFromAnalytics\": true,\n \"filters\": [\n {\n \"id\": \"11a1a1a1-a1a1-1a1a-a1a1-a1a111111111\",\n \"priority\": 1,\n \"action\": \"experienceInclude\",\n \"filterType\": \"device\",\n \"expression\": [\n {\n \"query\": {\n \"key\": \"deviceType\",\n \"value\": \"mobile\",\n \"filter\": \"equals\",\n \"type\": \"device\"\n }\n }\n ],\n \"expressionType\": \"common\",\n \"excludeFromAnalytics\": false\n },\n {\n \"id\": \"aa111111-1111-1a11-1111-11111111111a\",\n \"priority\": 2,\n \"action\": \"experienceInclude\",\n \"filterType\": \"visitor\",\n \"expression\": [\n {\n \"query\": {\n \"key\": \"visitorType\",\n \"value\": \"new\",\n \"filter\": \"equals\",\n \"type\": \"visitor\"\n }\n }\n ],\n \"expressionType\": \"common\",\n \"excludeFromAnalytics\": false\n },\n {\n \"id\": \"1aaaaaaa-aaaa-1111-1111-aa1111111111\",\n \"priority\": 3,\n \"action\": \"experienceInclude\",\n \"filterType\": \"trafficSource\",\n \"expression\": [\n {\n \"query\": {\n \"key\": \"trafficSource\",\n \"value\": \"email\",\n \"filter\": \"equals\",\n \"type\": \"trafficSource\"\n }\n }\n ],\n \"expressionType\": \"common\",\n \"excludeFromAnalytics\": false\n },\n {\n \"id\": \"aaaa1111-1111-1aaa-aaaa-1111aaaaaaaa\",\n \"priority\": 4,\n \"action\": \"experienceInclude\",\n \"filterType\": \"country\",\n \"expression\": [\n {\n \"query\": {\n \"key\": \"country\",\n \"value\": \"US\",\n \"filter\": \"equals\",\n \"type\": \"country\"\n }\n }\n ],\n \"expressionType\": \"common\",\n \"excludeFromAnalytics\": false\n }\n ],\n \"evaluationFrequency\": 1\n }\n }\n}'" } ], "parameters": [ { "in": "path", "name": "experienceId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "experience": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Display name shown in dashboards and reports." }, "description": { "description": "Internal note explaining what this experience tests. Helpful for team context.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "description": "Currency for price display and analytics. Omit to default to USD.", "anyOf": [ { "type": "object", "properties": { "code": { "default": "USD", "description": "ISO 4217 currency code used for analytics and price calculations.", "type": "string" }, "country": { "description": "ISO country code for locale-specific formatting.", "type": "string" }, "options": { "description": "Additional locale-specific formatting options." }, "symbol": { "default": "$", "description": "Display symbol prepended to amounts (e.g., '$', '\u20ac').", "type": "string" }, "suffix": { "description": "Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').", "type": "string" } } }, { "type": "null" } ] }, "previewPath": { "description": "Store URL path for generating preview links (e.g., '/products/example').", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "content/advanced", "content/onsiteEdits", "content/url", "content/theme", "content/template", "personalization", "personalization/offer" ], "description": "Immutable after creation. Must match the existing value from GET response." }, "experienceAnalysis": { "type": "object", "properties": { "analyticsViewType": { "default": "none", "description": "Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted.", "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ] } }, "description": "Controls which orders are included in analytics results." }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Identifies which experience to update." }, "variations": { "description": "Full replacement \u2014 include ALL variations to keep. Omitted variations are deleted. One must be control, percentages must sum to 100. Match variation mechanisms to experience type: onsiteEdits for DOM changes, onsiteInjection for CSS/JS, redirects for URL/theme/template tests.", "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Display name (e.g., 'Control', 'Variant A'). Must be unique across variations." }, "percentage": { "type": "number", "minimum": 0, "maximum": 100, "description": "Traffic allocation weight. All percentages across variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display order in analytics. Must be unique across variations. 0-indexed." }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ] } } } ] } }, "required": [ "key", "type", "filter" ] }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } } } } }, "required": [ "id", "expression" ] } }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Omitting a variation from the array deletes it." }, "onsiteEdits": { "default": [], "description": "Full replacement \u2014 include ALL edits to keep. Omitted edits are deleted. ONLY for DOM content changes (text replacement, HTML insertion, image swaps, element removal). Do NOT create onsiteEdits for visual styling changes like colors, backgrounds, fonts, or layout \u2014 use onsiteInjection.customCss instead. Leave as empty array when only CSS/JS changes are needed.", "type": "array", "items": { "type": "object", "properties": { "onsiteEditType": { "description": "Content modification strategy (rich HTML, plain text, image swap, or element removal).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to find on the page. Set isRegex=true for regex. Null when using querySelectors with 'hide' or 'image' type." }, "title": { "description": "Dashboard label for organizing multiple edits.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "Set to true to interpret 'find' as a regex pattern.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content: HTML markup for 'html' type, plain text for 'text', image URL for 'image'.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping where the edit applies (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "Set to true to temporarily disable without deleting.", "type": "boolean" }, "remove": { "default": false, "description": "Set to true to remove the matched element entirely instead of replacing.", "type": "boolean" }, "groupId": { "description": "Edits sharing a groupId are managed together as a unit.", "type": "string" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to target element. Null for content replacement (default)." }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname to match for image replacement. Mutually exclusive with querySelectors for image edits." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Identifies which onsite edit to preserve." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Must match the parent variation's id." } }, "required": [ "find", "insertType", "id", "variationId" ] } }, "onsiteInjection": { "description": "Full replacement. Set to null to remove. Use for all visual styling changes (background-color, font-size, colors, borders, layout, etc.) via customCss, and custom behavior via customJs. CSS-only changes should use ONLY this field with an empty onsiteEdits array \u2014 do not create a corresponding onsiteEdit.", "anyOf": [ { "type": "object", "properties": { "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Identifies which injection to update." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Must match the parent variation's id." } }, "required": [ "customCss", "customJs", "jsInjectionMode", "id", "variationId" ] }, { "type": "null" } ] }, "offer": { "anyOf": [ { "type": "object", "properties": { "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "minimumUnits": { "default": 1, "type": "number", "minimum": 0 }, "maximumUnits": { "default": 1, "type": "number", "minimum": 0 }, "unitDiscount": { "default": 1, "type": "number", "minimum": 0 }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ] } } }, "required": [ "type", "rules" ] } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ] }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Identifies which offer to update." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Must match the parent variation's id." } }, "required": [ "name", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount", "id", "variationId" ] }, { "type": "null" } ] }, "redirects": { "default": [], "type": "array", "items": { "type": "object", "properties": { "group": { "type": "number", "description": "Redirects sharing the same originUrl should use the same group number." }, "originUrl": { "type": "string", "description": "URL pattern to match. Matching behavior controlled by 'filter' field." }, "destinationUrl": { "description": "Target URL. Required when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Appended to the destination URL.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ] } }, "skip": { "type": "boolean", "description": "Set to true to temporarily disable without deleting." }, "isThemeTest": { "type": "boolean", "description": "Set to true for Shopify theme testing. Use with content/theme experience type." }, "isTemplateTest": { "type": "boolean", "description": "Set to true for Shopify template testing. Use with content/template experience type." }, "templateType": { "description": "Required when isTemplateTest is true.", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Template suffix variations to test. Required when isTemplateTest is true.", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "Set to true to fire only once per visitor session.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "How originUrl is matched against the current page URL.", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to find in the URL. Required when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "Full replacement navigates to destinationUrl; partial replacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Identifies which redirect to preserve." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Must match the parent variation's id." } }, "required": [ "group", "originUrl", "skip", "isThemeTest", "isTemplateTest", "id", "variationId" ] } } }, "required": [ "name", "percentage", "order", "id" ] } }, "audience": { "description": "Omit entirely to remove audience targeting from the experience.", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Set to true to enforce filter rules. When false, all visitors are included." }, "audienceType": { "description": "Complexity level: prebuilt common rules, simple custom rules, or advanced expression trees.", "type": "string", "enum": [ "common", "custom", "advanced" ] }, "elseAction": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "Fallback for visitors matching no filter: 'randomVariation' assigns randomly (most common), 'assignVariation' forces a specific variation (set elseVariationIndex), 'experienceExclude' removes from experience, 'leaveUnassigned' skips assignment." }, "elseExcludeFromAnalytics": { "default": false, "description": "Set to true to exclude non-matching visitors from analytics.", "type": "boolean" }, "filters": { "default": [], "description": "Evaluated in priority order (0-indexed). Each filter defines a targeting condition and resulting action.", "type": "array", "items": { "type": "object", "properties": { "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Evaluation order. 0-indexed. Filters with lower values are evaluated first." }, "action": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly." }, "filterType": { "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ], "description": "Category of targeting rule (e.g., UTM parameters, device type, visitor type)." }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value" ] }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } } } }, { "type": "null" } ], "description": "Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both." }, "expressionType": { "description": "Whether this uses prebuilt common rules or custom expression logic.", "anyOf": [ { "type": "string", "enum": [ "common", "custom" ] }, { "type": "null" } ] }, "variationId": { "description": "Variation to assign when action is 'assignVariation'. References a variation in the parent experience.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "excludeFromAnalytics": { "default": false, "description": "When true, visitors matching this filter are excluded from analytics even if included in the experience.", "type": "boolean" }, "id": { "description": "Server-generated. Read-only.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "priority", "action", "filterType" ] } }, "evaluationFrequency": { "description": "Seconds between re-evaluations for a visitor. Omit for default.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "elseVariationIndex": { "description": "0-based index into the variations array. Use instead of elseVariationId since IDs don't exist yet during creation.", "type": "string" }, "id": { "description": "Copy from GET response. Identifies which audience config to update.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "enabled", "elseAction" ] }, "experiencePageTargeting": { "default": [], "description": "Full replacement \u2014 include ALL page targeting rules to keep. Omitted rules are deleted.", "type": "array", "items": { "type": "object", "properties": { "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value" ] }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } } } }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Identifies which page targeting rule to preserve." } }, "required": [ "id" ] } }, "experienceKeyMetrics": { "default": [], "description": "Full replacement \u2014 include ALL metrics to keep. Omitted metrics are deleted. Exactly one must be primary.", "type": "array", "items": { "type": "object", "properties": { "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display order in analytics. Must be unique across metrics. 0-indexed." }, "isPrimary": { "default": false, "description": "Exactly one metric per experience must be primary.", "type": "boolean" }, "standardEventId": { "description": "Standard e-commerce event to track. Mutually exclusive with experienceCustomMetricId -- set exactly one.", "anyOf": [ { "type": "string", "enum": [ "conversionRate", "addToCartRate", "abandonedCartRate", "abandonedCheckoutRate", "checkoutBeginRate", "checkoutEnterContactInfoRate", "checkoutAddressSubmittedRate", "viewProductPageRate", "viewCollectionPageRate", "netRevenuePerVisitor", "netProductRevenuePerOrder", "netRevenuePerOrder", "avgUnitsPerOrder", "avgProductRevenuePerUnit", "profitPerVisitor", "profitPerOrder", "pctOrdersFreeShipping", "netShippingRevenuePerOrder", "subscriptionOrdersPerVisitor", "subscriptionRevenuePerVisitor", "subscriptionProfitPerVisitor", "subscriptionProductRevenuePerOrder", "avgDiscountPerDiscountedOrder", "avgDiscountPerAllOrders", "pctSubscriptionOrders", "subscriptionRevenuePerOrder" ] }, { "type": "null" } ] }, "experienceCustomMetricId": { "description": "References a custom metric. Mutually exclusive with standardEventId -- set exactly one.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Copy from GET response. Identifies which key metric to preserve." } }, "required": [ "order", "id" ] } } }, "required": [ "name", "type", "experienceAnalysis", "id", "variations" ], "description": "The complete experience object containing settings, variations, audience, page targeting, and key metrics. For PUT: include id fields from the GET response on all nested entities." } }, "required": [ "experience" ] } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "experience": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "name": { "type": "string", "description": "Display name shown in dashboards and reports." }, "isPreview": { "default": true, "description": "True while in draft mode. Must be set to false before the experience can be started.", "type": "boolean" }, "description": { "description": "Internal note explaining what this experience tests.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "devicePreview": { "description": "Device and path configuration for the preview iframe.", "anyOf": [ { "type": "object", "properties": { "device": { "default": "desktop", "description": "Viewport to simulate when rendering the preview.", "type": "string", "enum": [ "any", "mobile", "desktop" ] }, "path": { "default": "/", "description": "Storefront URL path to load in the preview (e.g., '/products/example').", "type": "string" } }, "required": [ "device", "path" ], "additionalProperties": false, "description": "Device and path configuration for previewing the experience." }, { "type": "null" } ] }, "organizationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only. The Shopify store that owns this experience." }, "type": { "type": "string", "enum": [ "content/advanced", "content/onsiteEdits", "content/url", "content/theme", "content/template", "personalization", "personalization/offer", "pricing", "shipping", "sitewide", "checkoutBlock", "postPurchase" ], "description": "Determines which variation fields are relevant: content/onsiteEdits for DOM edits, content/advanced for CSS/JS injection, content/url for redirect split tests, content/theme for theme tests, content/template for template tests." }, "category": { "type": "string", "enum": [ "experiment", "personalization" ], "description": "Distinguishes A/B experiments (statistical testing) from personalization rules (deterministic targeting)." }, "status": { "type": "string", "enum": [ "pending", "started", "ended", "paused" ], "description": "Server-managed lifecycle state. Transitions via start/pause/end actions: pending -> started -> paused/ended." }, "testTypes": { "type": "object", "properties": { "hasTestPricing": { "type": "boolean", "description": "Server-generated. Read-only. True when price testing is active." }, "hasTestShipping": { "type": "boolean", "description": "Server-generated. Read-only. True when shipping rate testing is active." }, "hasTestCampaign": { "type": "boolean", "description": "Server-generated. Read-only. True when campaign/offer testing is active." }, "hasTestContent": { "type": "boolean", "description": "Server-generated. Read-only. True when any content variation type is enabled." }, "hasTestContentUrl": { "type": "boolean", "description": "Server-generated. Read-only. True when URL redirect variations are in use." }, "hasTestContentAdvanced": { "type": "boolean", "description": "Server-generated. Read-only. True when custom JS/CSS variations are in use." }, "hasTestContentOnsite": { "type": "boolean", "description": "Server-generated. Read-only. True when visual onsite edit variations are in use." }, "hasTestContentTemplate": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify template variations are in use." }, "hasTestContentTheme": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify theme variations are in use." }, "hasTestOnsiteInjections": { "type": "boolean", "description": "Server-generated. Read-only. True when CSS/JS injection variations are in use." }, "hasTestCheckoutBlocks": { "type": "boolean", "description": "Server-generated. Read-only. True when checkout block variations are in use." }, "hasTestPostPurchase": { "type": "boolean", "description": "Server-generated. Read-only. True when post-purchase upsell variations are in use." } }, "required": [ "hasTestPricing", "hasTestShipping", "hasTestCampaign", "hasTestContent", "hasTestContentUrl", "hasTestContentAdvanced", "hasTestContentOnsite", "hasTestContentTemplate", "hasTestContentTheme", "hasTestOnsiteInjections", "hasTestCheckoutBlocks", "hasTestPostPurchase" ], "additionalProperties": false, "description": "Server-generated. Read-only. Flags derived from 'type' indicating which variation capabilities are active." }, "experiencePageTargeting": { "default": [], "description": "URL rules controlling which storefront pages this experience activates on. Empty means all pages.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filter": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "filterType": { "default": "url", "type": "string", "enum": [ "utm", "url", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie" ] }, "value": { "type": "string" }, "order": { "type": "number" }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "filterType", "value", "order" ], "additionalProperties": false } }, "experienceProductTargeting": { "default": [], "description": "Product attribute rules controlling which products this experience applies to. Empty means all products.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "target": { "type": "string", "enum": [ "productPage", "productCard" ], "description": "Storefront context where targeting rules are evaluated (product detail pages vs collection/search listings)." }, "expression": { "description": "Boolean expression tree of product attribute conditions. Each node has either a 'query' (leaf) or 'operator' (combinator).", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Product attribute to filter on. Determines which product property is evaluated." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Expected value. String for text attributes (productId, collection, tag); number for numeric attributes (price, inventory)." }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan" ], "description": "Comparison operator for evaluating the product attribute against the value." }, "type": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Mirrors the key field. Determines attribute category for validation." } }, "required": [ "key", "value", "filter", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "target" ], "additionalProperties": false } }, "experienceActions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string", "enum": [ "start", "pause", "end", "delete", "reset" ] }, "actionTs": { "type": "number" }, "performedBy": { "description": "Email of the user who triggered this lifecycle event. Resolved from History records by matching action type and timestamp within a 5-minute window. Null if no matching History record is found, or if the record has no associated user. Currently only populated by GET /experiences/{experienceId}; list endpoints return null.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "action", "actionTs" ], "additionalProperties": false }, "description": "Server-generated. Read-only. Lifecycle state transitions (start, pause, end, delete, reset) recorded for this experience. On GET /experiences/{experienceId}, each entry includes a `performedBy` field with the triggering user's email, resolved from History records (may be null if unresolvable). Distinct from the list endpoint's raw `history` field, which contains broader user-action records." }, "experienceIntegrations": { "default": [], "description": "Connected third-party integrations (e.g., Google Analytics, Segment).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAtTs": { "type": "number" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "enum": [ "Recharge", "StayAi", "GrowLTV", "OneClickUpsell", "Google", "Amped", "Clarity", "Hotjar", "Heatmap", "CustomApi", "Klaviyo", "Slack", "Amplitude", "Heap", "Segment", "IntelligemsAPI", "IntelligemsMcp" ] }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "globalSettings": {}, "apis": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessToken": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "read_experiments", "write_experiments", "write_test_groups", "read_integrations" ] } }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "name", "accessToken", "scopes", "organization" ], "additionalProperties": false } }, "createdAtTs": { "type": "number" }, "lastUpdateTs": { "type": "number" } }, "required": [ "id", "name", "description", "enabled", "globalSettings", "apis" ], "additionalProperties": false }, "experienceSettings": {}, "enabled": { "default": false, "type": "boolean" } }, "required": [ "id", "createdAtTs", "integration", "experienceSettings", "enabled" ], "additionalProperties": false } }, "experienceCustomMetrics": { "default": [], "description": "Custom event-based metrics tracked alongside standard key metrics.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "number", "description": "Display position in the analytics dashboard. 0-indexed." }, "customEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the custom event definition configured in the organization's analytics settings." }, "customEvent": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "pageView" }, "settings": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "productPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "handle": { "type": "string" } }, "required": [ "productId", "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "collectionPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "handle": { "type": "string" } }, "required": [ "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "clickEvent" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "elementViewed" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "scrollDepth" }, "settings": { "type": "object", "properties": { "mobile": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false } }, "required": [ "mobile", "desktop" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptEvent" }, "settings": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptImportedEvent" }, "settings": { "type": "object", "properties": { "registered": { "type": "boolean" } }, "required": [ "registered" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false } ], "description": "Server-generated. Read-only. Expanded custom event definition with name, tracking details, and configuration.", "type": "object" } }, "required": [ "id", "experienceId", "order", "customEventId", "customEvent" ], "additionalProperties": false } }, "experienceKeyMetrics": { "default": [], "description": "Business metrics (revenue, conversion, AOV, etc.) used to evaluate test performance. One must be primary.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display position in the analytics dashboard. 0-indexed." }, "isPrimary": { "default": false, "description": "The primary metric determines the main success signal for the test. Exactly one per experience.", "type": "boolean" }, "standardEventId": { "description": "Standard e-commerce event (e.g., revenue, conversion). Mutually exclusive with experienceCustomMetricId.", "anyOf": [ { "type": "string", "enum": [ "conversionRate", "addToCartRate", "abandonedCartRate", "abandonedCheckoutRate", "checkoutBeginRate", "checkoutEnterContactInfoRate", "checkoutAddressSubmittedRate", "viewProductPageRate", "viewCollectionPageRate", "netRevenuePerVisitor", "netProductRevenuePerOrder", "netRevenuePerOrder", "avgUnitsPerOrder", "avgProductRevenuePerUnit", "profitPerVisitor", "profitPerOrder", "pctOrdersFreeShipping", "netShippingRevenuePerOrder", "subscriptionOrdersPerVisitor", "subscriptionRevenuePerVisitor", "subscriptionProfitPerVisitor", "subscriptionProductRevenuePerOrder", "avgDiscountPerDiscountedOrder", "avgDiscountPerAllOrders", "pctSubscriptionOrders", "subscriptionRevenuePerOrder" ] }, { "type": "null" } ] }, "experienceCustomMetricId": { "description": "References a custom event metric. Mutually exclusive with standardEventId. Exactly one of these must be set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "order", "isPrimary" ], "additionalProperties": false } }, "currency": { "description": "Currency settings for price display and analytics calculations. Null inherits store default.", "anyOf": [ { "type": "object", "properties": { "code": { "default": "USD", "description": "ISO 4217 currency code used for analytics and price calculations.", "type": "string" }, "country": { "description": "ISO country code for locale-specific formatting.", "type": "string" }, "options": { "description": "Additional locale-specific formatting options." }, "symbol": { "default": "$", "description": "Display symbol prepended to amounts (e.g., '$', '\u20ac').", "type": "string" }, "suffix": { "description": "Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').", "type": "string" } }, "required": [ "code", "symbol" ], "additionalProperties": false }, { "type": "null" } ] }, "variations": { "default": [], "description": "Test variants including the control. One must be control; traffic percentages must sum to 100.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "name": { "type": "string", "description": "Display name (e.g., 'Control', 'Variant A'). Unique within the experience." }, "percentage": { "type": "number", "description": "Traffic allocation weight. All percentages across sibling variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order in the analytics dashboard. 0-indexed." }, "priceChange": { "description": "Price adjustment amount for pricing-type experiences. Positive increases price, negative discounts. Use priceChange for simple price A/B tests; use offer for structured discount campaigns (tiered, BOGO, free shipping).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priceChangeUnit": { "description": "How priceChange is applied: as a percentage of the original price or a fixed monetary amount.", "anyOf": [ { "type": "string", "enum": [ "percent", "dollar" ] }, { "type": "null" } ] }, "priceRoundingType": { "description": "Rounding strategy applied after priceChange (e.g., round up, round down, charm pricing).", "anyOf": [ { "type": "string", "enum": [ "none", "nearest", "up", "down" ] }, { "type": "null" } ] }, "priceRoundingAmount": { "description": "Target value for rounding (e.g., 0.99 for charm pricing like $X.99).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onsiteEdits": { "default": [], "description": "DOM content modifications (text, HTML, image swaps, element removal). For CSS styling changes, use onsiteInjections instead.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "onsiteEditType": { "description": "Content modification strategy (html, text, image, or hide).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to locate on the page. Interpreted as regex when isRegex is true." }, "title": { "description": "Dashboard label for identifying this edit.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "When true, 'find' is treated as a regular expression.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content. Interpretation depends on onsiteEditType: HTML markup, plain text, or image URL.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping which DOM elements this edit targets (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "When true, this edit is temporarily disabled without being deleted.", "type": "boolean" }, "remove": { "default": false, "description": "When true, the matched element is removed from the DOM instead of having its content replaced.", "type": "boolean" }, "groupId": { "description": "Groups related edits together so they can be managed as a unit.", "type": "string" }, "isHtml": { "default": false, "type": "boolean" }, "isImage": { "default": false, "type": "boolean" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to the target (beforebegin, afterbegin, beforeend, afterend). Null means content replacement." }, "createdAtUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Server-generated. Read-only. Storefront URL where this edit was originally created via the visual editor." }, "createdAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname for locating images to replace. When set, images are found by URL match; when null, querySelectors is used instead." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "find", "isRegex", "replace", "querySelectors", "skip", "remove", "isHtml", "isImage", "insertType" ], "additionalProperties": false } }, "onsiteInjections": { "description": "CSS styling and custom JS injection. At most one per variation. For DOM content changes (text, images, HTML), use onsiteEdits instead.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "type" ], "additionalProperties": false, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "jsInjectionMode" ], "additionalProperties": false }, { "type": "null" } ] }, "offer": { "description": "Structured discount configuration (tiered volume discounts, cart-level discounts, gift-with-purchase, free shipping). Use offer for campaign/discount experiences; use priceChange for simple price A/B tests.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation this offer belongs to." }, "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "description": "Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "minimumUnits": { "default": 1, "type": "number" }, "maximumUnits": { "default": 1, "type": "number" }, "unitDiscount": { "default": 1, "type": "number" }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "minimumUnits", "maximumUnits", "unitDiscount", "discountTitle", "giftWithPurchaseTitle", "isFreeShipping", "isGiftWithPurchase", "autoAddGiftWithPurchase" ], "additionalProperties": false } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ], "additionalProperties": false } } }, "required": [ "type", "rules" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ], "additionalProperties": false }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] } }, "required": [ "id", "variationId", "enabled", "isTest", "isArchived", "name", "unitType", "discountType", "tiers", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount", "requireSameItem", "subscriptionApplicationType" ], "additionalProperties": false }, { "type": "null" } ] }, "offerId": { "description": "Server-generated. Read-only. References the associated offer. Populated when offer is set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "shippingRateGroups": { "description": "Shipping rate overrides. Only populated for shipping test experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupType": { "type": "string", "enum": [ "flatRate", "flatRateWithThreshold", "thresholdOnly", "tieredByPriceOrWeight", "custom" ] }, "position": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "amount": { "type": "number" }, "rateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rateType": { "type": "string", "enum": [ "amount", "threshold", "tier" ] }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SRD", "STD", "SZL", "THB", "TJS", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "min": { "default": 0, "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "conditionType": { "type": "string", "enum": [ "currency", "weight" ] }, "unit": { "anyOf": [ { "type": "string", "enum": [ "g", "kg", "lb", "oz" ] }, { "type": "null" } ] } }, "required": [ "min", "conditionType" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "amount", "rateType", "currency" ], "additionalProperties": false } }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "groupType", "position", "rates", "variationId" ], "additionalProperties": false } }, "excludeProducts": { "description": "When true, specific products are excluded from price changes. Use excludeProducts when most products should be tested and only a few excluded. Mutually exclusive with includeProducts.", "default": false, "type": "boolean" }, "includeProducts": { "description": "When true, only specific products receive price changes. Use includeProducts when only a few products should be tested. Mutually exclusive with excludeProducts.", "default": false, "type": "boolean" }, "testExperienceId": { "description": "Links to another experience for advanced multi-experience configurations.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "functionSyncError": { "default": false, "description": "Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.", "type": "boolean" }, "redirects": { "description": "URL redirect rules for content/url experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "group": { "type": "number", "description": "Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "originUrl": { "type": "string", "description": "URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field." }, "destinationUrl": { "description": "Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Key-value pairs appended to the destination URL as query parameters.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ], "additionalProperties": false } }, "skip": { "type": "boolean", "description": "When true, this redirect is temporarily disabled." }, "isThemeTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify themes. Used with content/theme experiences." }, "isTemplateTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify templates. Used with content/template experiences." }, "templateType": { "description": "Shopify template type being tested (e.g., product, collection).", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "When true, the redirect fires only once per visitor session to avoid redirect loops.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "id", "group", "variationId", "originUrl", "queryParams", "skip", "isThemeTest", "isTemplateTest", "templateSuffixes", "redirectOnce", "filter", "redirectType" ], "additionalProperties": false } }, "userInterfaces": { "description": "UI widget configurations displayed for this variation.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "isEnabled": { "type": "boolean" }, "isArchived": { "default": false, "type": "boolean" }, "widget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "enabledSitewide": { "default": false, "type": "boolean" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "widgetType": { "type": "string", "enum": [ "messageBoxPopup", "messageBoxSlideOut", "quantityButtons", "discountProgressBar", "shippingProgressBar" ] }, "config": { "type": "object", "properties": { "desktop": {}, "mobile": {} }, "additionalProperties": false } }, "required": [ "id", "name", "enabledSitewide", "widgetType", "config" ], "additionalProperties": false }, "widgetId": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "quantityButtons", "progressBar", "messageBox" ] }, "variationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "desktopVariables": { "anyOf": [ {}, { "type": "null" } ] }, "mobileVariables": { "anyOf": [ {}, { "type": "null" } ] }, "styleOverrides": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "id", "isArchived", "widgetId" ], "additionalProperties": false } }, "checkoutBlocks": { "description": "Shopify checkout extensibility block configurations for this variation.", "default": [], "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "trustBadge" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconSize": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageSize": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 500 }, { "type": "null" } ] }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaSpacing": { "type": "string" } }, "required": [ "order", "type", "imageSize", "imageSizeUnit", "mediaSpacing" ], "additionalProperties": false } } }, "required": [ "headerText", "items" ], "additionalProperties": false, "description": "Configurable content for the trust badge (e.g., badge images, guarantee text)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemSubtitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "itemTitle", "itemSubtitle" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" } }, "required": [ "header", "item", "block" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "itemTitleText": { "type": "string" }, "itemSubtitleText": { "type": "string" } }, "required": [ "headerText", "itemTitleText", "itemSubtitleText" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "rowCount", "columnCount" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "itemBorderThickness": { "type": "string" }, "itemBorderStyle": { "default": "none", "type": "string" }, "itemCornerRadius": { "type": "string" }, "itemTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "itemBorderThickness", "itemBorderStyle", "itemCornerRadius", "itemTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the trust badge appearance." } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "upsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "maxProductLimit": { "default": 3, "type": "integer", "minimum": 1, "maximum": 10 }, "excludeItemsInCart": { "default": false, "type": "boolean" }, "excludeOutOfStock": { "default": false, "type": "boolean" }, "buttonText": { "type": "string" }, "imageSize": { "type": "number", "minimum": 1, "maximum": 500 }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "type": "string" }, "mediaSpacing": { "type": "string" } }, "required": [ "headerText", "maxProductLimit", "excludeItemsInCart", "excludeOutOfStock", "buttonText", "imageSize", "imageSizeUnit", "imageAspectRatio", "mediaSpacing" ], "additionalProperties": false, "description": "Configurable content for the upsell block (e.g., product selection, heading text, CTA label)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "variantTitle": { "default": { "fontSize": "base", "fontStyle": "normal" }, "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "productTitle", "variantTitle", "price", "button" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" }, "button": { "type": "string" }, "productUnit": { "type": "string" } }, "required": [ "header", "item", "block", "button", "productUnit" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "productText": { "type": "string" }, "variantText": { "default": "subdued", "type": "string" }, "priceText": { "type": "string" }, "carouselArrowColor": { "default": "monochrome", "type": "string" }, "carouselArrowStyle": { "default": "primary", "type": "string" } }, "required": [ "headerText", "productText", "variantText", "priceText", "carouselArrowColor", "carouselArrowStyle" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "mobile": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "mobile", "desktop" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "productBorderThickness": { "type": "string" }, "productBorderStyle": { "default": "none", "type": "string" }, "productCornerRadius": { "type": "string" }, "productTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "productBorderThickness", "productBorderStyle", "productCornerRadius", "productTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the upsell block appearance." }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "postPurchaseUpsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "discountType": { "default": "none", "type": "string", "enum": [ "none", "percentage", "fixed" ] }, "discountValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "compareAtPriceDisplay": { "default": "none", "type": "string", "enum": [ "none", "compareAtPrice", "regularPrice" ] }, "imageAspectRatio": { "type": "string" }, "excludeOutOfStock": { "type": "boolean" }, "excludeItemsInCart": { "type": "boolean" }, "maxProductLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bannerEnabled": { "type": "boolean" }, "bannerTitle": { "type": "string" }, "bannerSubtitle": { "type": "string" }, "compareAtPriceEnabled": { "type": "boolean" }, "descriptionEnabled": { "type": "boolean" }, "quantitySelectorEnabled": { "type": "boolean" }, "quantityLabel": { "type": "string" }, "maxQuantityType": { "type": "string" }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "moneyLineEnabled": { "type": "boolean" }, "moneyLineSubtotal": { "type": "boolean" }, "moneyLineShipping": { "type": "boolean" }, "moneyLineTaxes": { "type": "boolean" }, "primaryButtonText": { "type": "string" }, "secondaryButtonEnabled": { "type": "boolean" }, "secondaryButtonText": { "type": "string" }, "headingLevel": { "type": "string" } }, "required": [ "headerText", "discountType", "compareAtPriceDisplay", "imageAspectRatio", "excludeOutOfStock", "excludeItemsInCart", "maxProductLimit", "bannerEnabled", "compareAtPriceEnabled", "descriptionEnabled", "quantitySelectorEnabled", "moneyLineEnabled", "moneyLineSubtotal", "moneyLineShipping", "moneyLineTaxes", "primaryButtonText", "secondaryButtonEnabled", "headingLevel" ], "additionalProperties": false }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "description": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "primaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "secondaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "productTitle", "price", "primaryButton" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "banner": { "type": "string" }, "primaryButton": { "type": "string" }, "secondaryButton": { "type": "string" } }, "required": [ "banner", "primaryButton" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "bannerText": { "type": "string" }, "productText": { "type": "string" }, "priceText": { "type": "string" }, "descriptionText": { "type": "string" }, "primaryButtonText": { "type": "string" }, "secondaryButtonText": { "type": "string" } }, "required": [ "productText", "priceText", "primaryButtonText" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "bannerBorderStyle": { "type": "string" }, "bannerSpacing": { "type": "string" }, "bannerTextAlign": { "type": "string" }, "separatorWidth": { "type": "string" }, "imageFit": { "type": "string" }, "imageBorder": { "type": "boolean" }, "pricingAppearance": { "type": "string" }, "pricingEmphasized": { "type": "boolean" }, "pricingSubduedStyle": { "type": "boolean" }, "descriptionSubdued": { "type": "boolean" }, "secondaryButtonStyle": { "type": "string" } }, "required": [ "bannerBorderStyle", "bannerSpacing", "bannerTextAlign", "separatorWidth", "imageFit", "imageBorder", "pricingEmphasized", "descriptionSubdued", "secondaryButtonStyle" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "appearance" ], "additionalProperties": false }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false } ], "type": "object" } }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false } } }, "required": [ "id", "experienceId", "name", "percentage", "isControl", "order", "onsiteEdits", "functionSyncError" ], "additionalProperties": false } }, "createdAtTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds." }, "isDeleted": { "description": "Whether this experience has been soft-deleted and hidden from default listings.", "type": "boolean" }, "shippingTestMethodDefinitions": { "default": [], "description": "Shipping rate configurations. Only populated for shipping test experiences.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deliveryProfileId": { "type": "string" }, "deliveryLocationGroupId": { "type": "string" }, "deliveryZoneId": { "type": "string" }, "methodDefinitionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canonicalMethodId": { "type": "string" }, "deleteTargetKind": { "type": "string", "enum": [ "canonical_method", "participant_method", "synthetic_free_condition", "synthetic_rate_definition" ] }, "deleteTargetRateDefinitionId": { "type": "string" }, "deleteTargetFreeCondition": { "type": "object", "properties": { "subject": { "type": "string" }, "min": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] } }, "required": [ "subject" ], "additionalProperties": false } }, "required": [ "deliveryProfileId", "deliveryLocationGroupId", "deliveryZoneId" ], "additionalProperties": false } }, "audience": { "description": "Visitor segmentation rules. Null means all visitors are eligible.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "enabled": { "type": "boolean", "description": "When false, audience rules are ignored and all visitors are eligible." }, "excludeCurrency": { "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Whether currency/geo-based exclusion is active." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 4217 currency code to exclude. Null disables currency-based exclusion." }, "country": { "description": "ISO country code to exclude visitors from.", "type": "string" }, "region": { "description": "Region or state code to exclude visitors from.", "type": "string" }, "city": { "description": "City name to exclude visitors from.", "type": "string" } }, "required": [ "exclude", "currency" ], "additionalProperties": false, "description": "Currency and geo-based visitor exclusion configuration." }, "wholesale": { "type": "boolean", "description": "Controls whether wholesale (B2B) customers are included in or excluded from the experience." }, "audienceType": { "description": "Complexity level of the targeting rules: common (prebuilt), custom (simple), or advanced (full expression trees).", "type": "string", "enum": [ "common", "custom", "advanced" ] }, "elseAction": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "Fallback for visitors matching no filter: 'randomVariation' assigns randomly across variations (most common), 'assignVariation' forces a specific variation (set elseVariationId), 'experienceExclude' removes them from the experience entirely, 'leaveUnassigned' skips assignment." }, "elseVariationId": { "description": "Variation to force-assign when elseAction is 'assignVariation'. Typically set to the control variation to default non-targeted visitors to baseline.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "elseExcludeFromAnalytics": { "default": false, "description": "When true, visitors who match no filter are tracked but excluded from analytics calculations.", "type": "boolean" }, "filters": { "default": [], "description": "Ordered filter rules evaluated from lowest priority value first (0-indexed). First matching filter determines visitor treatment.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Evaluation order. 0-indexed. Filters with lower values are evaluated first." }, "action": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly." }, "filterType": { "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ], "description": "Category of targeting rule (e.g., UTM parameters, device type, visitor type)." }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ], "description": "Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both." }, "expressionType": { "description": "Whether this uses prebuilt common rules or custom expression logic.", "anyOf": [ { "type": "string", "enum": [ "common", "custom" ] }, { "type": "null" } ] }, "variationId": { "description": "Variation to assign when action is 'assignVariation'. References a variation in the parent experience.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "excludeFromAnalytics": { "default": false, "description": "When true, visitors matching this filter are excluded from analytics even if included in the experience.", "type": "boolean" } }, "required": [ "id", "priority", "action", "filterType", "excludeFromAnalytics" ], "additionalProperties": false } }, "evaluationFrequency": { "description": "How often (in seconds) to re-evaluate audience rules for a returning visitor. Controls targeting freshness.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "enabled", "excludeCurrency", "wholesale", "elseAction", "elseExcludeFromAnalytics", "filters" ], "additionalProperties": false }, { "type": "null" } ] }, "lastUpdateTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds of the most recent modification." }, "previewPath": { "description": "Storefront URL path used when generating preview links (e.g., '/products/example').", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isExternal": { "description": "True if this experience was created and is managed via the external API rather than the dashboard.", "anyOf": [ { "default": false, "type": "boolean" }, { "type": "null" } ] }, "startedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if never started." }, "pausedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not currently paused." }, "archivedAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not archived.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "requiresLink": { "default": false, "description": "When true, visitors must use a special link to enter the experience instead of being auto-assigned.", "type": "boolean" }, "linkBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Base URL for generating access links. Only populated when requiresLink is true." }, "endedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if still active." }, "productVariantCount": { "default": 0, "description": "Server-generated. Read-only. Total product variants currently included in this experience.", "type": "number" }, "sourceExperienceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Present when this experience was duplicated or rolled out from another. References the original." }, "sourceAction": { "anyOf": [ { "type": "string", "enum": [ "duplicate", "rollout" ] }, { "type": "null" } ], "description": "How this experience was derived from sourceExperienceId. Only present when sourceExperienceId is set." }, "experienceAnalysis": { "type": "object", "properties": { "analyticsViewType": { "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ], "description": "Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted." } }, "required": [ "analyticsViewType" ], "additionalProperties": false } }, "required": [ "id", "name", "isPreview", "organizationId", "type", "category", "status", "testTypes", "experiencePageTargeting", "experienceProductTargeting", "experienceActions", "experienceIntegrations", "experienceCustomMetrics", "experienceKeyMetrics", "variations", "createdAtTs", "shippingTestMethodDefinitions", "lastUpdateTs", "startedAtTs", "pausedAtTs", "requiresLink", "linkBaseUrl", "endedAtTs", "productVariantCount", "experienceAnalysis" ], "additionalProperties": false, "description": "Full single-experience payload returned by GET /experiences/{experienceId}. Includes `experienceCustomMetrics`, `experienceIntegrations`, `experienceKeyMetrics`, and `shippingTestMethodDefinitions`. Unlike GET /experiences-list items, this response does not include `history`." } }, "required": [ "experience" ], "additionalProperties": false } } } } } } }, "/v25-10-beta/experiences/{experienceId}/actions/{action}": { "post": { "tags": [ "Perform Experience Action" ], "description": "Performs an action on an experience to control its lifecycle.\n\n### Supported Actions\n\n- `start` - Activate the experience and begin serving it to visitors\n- `pause` - Temporarily stop serving the experience (can be resumed with start)\n- `end` - Permanently end the experience\n\n### Important Notes\n\n- The experience must exist and belong to your organization\n- Starting an experience sets it live and removes preview mode\n- Pausing or ending an experience returns it to preview mode\n- Only certain state transitions are valid (e.g., cannot pause an already ended experience)\n\n### Request Body Fields\n\n- `variationId` (string UUID, optional) \u2014 The ID of the variation to apply. When ending an experience, this selects the winning variation.\n\n### Usage Examples\n\n**Start an experience** (no body fields needed):\n\n```\nPOST /v25-10-beta/experiences/{experienceId}/actions/start\nBody: {}\n```\n\n**Pause an experience** (no body fields needed for content tests):\n\n```\nPOST /v25-10-beta/experiences/{experienceId}/actions/pause\nBody: {}\n```\n\n**End an experience** with a winning variation:\n\n```\nPOST /v25-10-beta/experiences/{experienceId}/actions/end\nBody: { \"variationId\": \"\", \"updatePricesToVariation\": true }\n```", "security": [ { "intelligems_access_token": [] } ], "parameters": [ { "in": "path", "name": "experienceId", "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "required": true }, { "in": "path", "name": "action", "schema": { "type": "string", "enum": [ "start", "pause", "end" ] }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "variationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "updatePricesToVariation": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "OK", "headers": { "access-control-allow-origin": { "schema": { "type": "string" }, "description": "CORS allow-origin header." }, "access-control-allow-credentials": { "schema": { "type": "string" }, "description": "CORS allow-credentials header." }, "content-type": { "schema": { "type": "string" }, "description": "Response content type." }, "Timing-Allow-Origin": { "schema": { "type": "string" }, "description": "Allowed origin for Timing headers." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "experience": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "name": { "type": "string", "description": "Display name shown in dashboards and reports." }, "isPreview": { "default": true, "description": "True while in draft mode. Must be set to false before the experience can be started.", "type": "boolean" }, "description": { "description": "Internal note explaining what this experience tests.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "devicePreview": { "description": "Device and path configuration for the preview iframe.", "anyOf": [ { "type": "object", "properties": { "device": { "default": "desktop", "description": "Viewport to simulate when rendering the preview.", "type": "string", "enum": [ "any", "mobile", "desktop" ] }, "path": { "default": "/", "description": "Storefront URL path to load in the preview (e.g., '/products/example').", "type": "string" } }, "required": [ "device", "path" ], "additionalProperties": false, "description": "Device and path configuration for previewing the experience." }, { "type": "null" } ] }, "organizationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only. The Shopify store that owns this experience." }, "type": { "type": "string", "enum": [ "content/advanced", "content/onsiteEdits", "content/url", "content/theme", "content/template", "personalization", "personalization/offer", "pricing", "shipping", "sitewide", "checkoutBlock", "postPurchase" ], "description": "Determines which variation fields are relevant: content/onsiteEdits for DOM edits, content/advanced for CSS/JS injection, content/url for redirect split tests, content/theme for theme tests, content/template for template tests." }, "category": { "type": "string", "enum": [ "experiment", "personalization" ], "description": "Distinguishes A/B experiments (statistical testing) from personalization rules (deterministic targeting)." }, "status": { "type": "string", "enum": [ "pending", "started", "ended", "paused" ], "description": "Server-managed lifecycle state. Transitions via start/pause/end actions: pending -> started -> paused/ended." }, "testTypes": { "type": "object", "properties": { "hasTestPricing": { "type": "boolean", "description": "Server-generated. Read-only. True when price testing is active." }, "hasTestShipping": { "type": "boolean", "description": "Server-generated. Read-only. True when shipping rate testing is active." }, "hasTestCampaign": { "type": "boolean", "description": "Server-generated. Read-only. True when campaign/offer testing is active." }, "hasTestContent": { "type": "boolean", "description": "Server-generated. Read-only. True when any content variation type is enabled." }, "hasTestContentUrl": { "type": "boolean", "description": "Server-generated. Read-only. True when URL redirect variations are in use." }, "hasTestContentAdvanced": { "type": "boolean", "description": "Server-generated. Read-only. True when custom JS/CSS variations are in use." }, "hasTestContentOnsite": { "type": "boolean", "description": "Server-generated. Read-only. True when visual onsite edit variations are in use." }, "hasTestContentTemplate": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify template variations are in use." }, "hasTestContentTheme": { "type": "boolean", "description": "Server-generated. Read-only. True when Shopify theme variations are in use." }, "hasTestOnsiteInjections": { "type": "boolean", "description": "Server-generated. Read-only. True when CSS/JS injection variations are in use." }, "hasTestCheckoutBlocks": { "type": "boolean", "description": "Server-generated. Read-only. True when checkout block variations are in use." }, "hasTestPostPurchase": { "type": "boolean", "description": "Server-generated. Read-only. True when post-purchase upsell variations are in use." } }, "required": [ "hasTestPricing", "hasTestShipping", "hasTestCampaign", "hasTestContent", "hasTestContentUrl", "hasTestContentAdvanced", "hasTestContentOnsite", "hasTestContentTemplate", "hasTestContentTheme", "hasTestOnsiteInjections", "hasTestCheckoutBlocks", "hasTestPostPurchase" ], "additionalProperties": false, "description": "Server-generated. Read-only. Flags derived from 'type' indicating which variation capabilities are active." }, "experiencePageTargeting": { "default": [], "description": "URL rules controlling which storefront pages this experience activates on. Empty means all pages.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filter": { "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "filterType": { "default": "url", "type": "string", "enum": [ "utm", "url", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie" ] }, "value": { "type": "string" }, "order": { "type": "number" }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "filterType", "value", "order" ], "additionalProperties": false } }, "experienceProductTargeting": { "default": [], "description": "Product attribute rules controlling which products this experience applies to. Empty means all products.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "target": { "type": "string", "enum": [ "productPage", "productCard" ], "description": "Storefront context where targeting rules are evaluated (product detail pages vs collection/search listings)." }, "expression": { "description": "Boolean expression tree of product attribute conditions. Each node has either a 'query' (leaf) or 'operator' (combinator).", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Product attribute to filter on. Determines which product property is evaluated." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Expected value. String for text attributes (productId, collection, tag); number for numeric attributes (price, inventory)." }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan" ], "description": "Comparison operator for evaluating the product attribute against the value." }, "type": { "type": "string", "enum": [ "productId", "collection", "tag", "price", "inventory" ], "description": "Mirrors the key field. Determines attribute category for validation." } }, "required": [ "key", "value", "filter", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "target" ], "additionalProperties": false } }, "experienceActions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string", "enum": [ "start", "pause", "end", "delete", "reset" ] }, "actionTs": { "type": "number" }, "performedBy": { "description": "Email of the user who triggered this lifecycle event. Resolved from History records by matching action type and timestamp within a 5-minute window. Null if no matching History record is found, or if the record has no associated user. Currently only populated by GET /experiences/{experienceId}; list endpoints return null.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "action", "actionTs" ], "additionalProperties": false }, "description": "Server-generated. Read-only. Lifecycle state transitions (start, pause, end, delete, reset) recorded for this experience. On GET /experiences/{experienceId}, each entry includes a `performedBy` field with the triggering user's email, resolved from History records (may be null if unresolvable). Distinct from the list endpoint's raw `history` field, which contains broader user-action records." }, "experienceIntegrations": { "default": [], "description": "Connected third-party integrations (e.g., Google Analytics, Segment).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAtTs": { "type": "number" }, "integration": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "enum": [ "Recharge", "StayAi", "GrowLTV", "OneClickUpsell", "Google", "Amped", "Clarity", "Hotjar", "Heatmap", "CustomApi", "Klaviyo", "Slack", "Amplitude", "Heap", "Segment", "IntelligemsAPI", "IntelligemsMcp" ] }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "globalSettings": {}, "apis": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessToken": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "read_experiments", "write_experiments", "write_test_groups", "read_integrations" ] } }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "name", "accessToken", "scopes", "organization" ], "additionalProperties": false } }, "createdAtTs": { "type": "number" }, "lastUpdateTs": { "type": "number" } }, "required": [ "id", "name", "description", "enabled", "globalSettings", "apis" ], "additionalProperties": false }, "experienceSettings": {}, "enabled": { "default": false, "type": "boolean" } }, "required": [ "id", "createdAtTs", "integration", "experienceSettings", "enabled" ], "additionalProperties": false } }, "experienceCustomMetrics": { "default": [], "description": "Custom event-based metrics tracked alongside standard key metrics.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "number", "description": "Display position in the analytics dashboard. 0-indexed." }, "customEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the custom event definition configured in the organization's analytics settings." }, "customEvent": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "pageView" }, "settings": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "productPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "handle": { "type": "string" } }, "required": [ "productId", "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "collectionPageView" }, "settings": { "type": "array", "items": { "type": "object", "properties": { "handle": { "type": "string" } }, "required": [ "handle" ], "additionalProperties": false } } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "clickEvent" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "elementViewed" }, "settings": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "type": "string" } } }, "required": [ "selectors" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "scrollDepth" }, "settings": { "type": "object", "properties": { "mobile": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "percentage": { "type": "number" } }, "required": [ "percentage" ], "additionalProperties": false } }, "required": [ "mobile", "desktop" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptEvent" }, "settings": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventCountLastDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastEventTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAtTs": { "type": "number" }, "archivedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "applyToUrls": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "matchBy": { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, "value": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "matchBy", "value" ], "additionalProperties": false } }, { "type": "null" } ] }, "experiencesList": { "anyOf": [ { "default": [], "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string", "const": "javascriptImportedEvent" }, "settings": { "type": "object", "properties": { "registered": { "type": "boolean" } }, "required": [ "registered" ], "additionalProperties": false } }, "required": [ "id", "identifier", "name", "createdAtTs", "type", "settings" ], "additionalProperties": false } ], "description": "Server-generated. Read-only. Expanded custom event definition with name, tracking details, and configuration.", "type": "object" } }, "required": [ "id", "experienceId", "order", "customEventId", "customEvent" ], "additionalProperties": false } }, "experienceKeyMetrics": { "default": [], "description": "Business metrics (revenue, conversion, AOV, etc.) used to evaluate test performance. One must be primary.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "order": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Display position in the analytics dashboard. 0-indexed." }, "isPrimary": { "default": false, "description": "The primary metric determines the main success signal for the test. Exactly one per experience.", "type": "boolean" }, "standardEventId": { "description": "Standard e-commerce event (e.g., revenue, conversion). Mutually exclusive with experienceCustomMetricId.", "anyOf": [ { "type": "string", "enum": [ "conversionRate", "addToCartRate", "abandonedCartRate", "abandonedCheckoutRate", "checkoutBeginRate", "checkoutEnterContactInfoRate", "checkoutAddressSubmittedRate", "viewProductPageRate", "viewCollectionPageRate", "netRevenuePerVisitor", "netProductRevenuePerOrder", "netRevenuePerOrder", "avgUnitsPerOrder", "avgProductRevenuePerUnit", "profitPerVisitor", "profitPerOrder", "pctOrdersFreeShipping", "netShippingRevenuePerOrder", "subscriptionOrdersPerVisitor", "subscriptionRevenuePerVisitor", "subscriptionProfitPerVisitor", "subscriptionProductRevenuePerOrder", "avgDiscountPerDiscountedOrder", "avgDiscountPerAllOrders", "pctSubscriptionOrders", "subscriptionRevenuePerOrder" ] }, { "type": "null" } ] }, "experienceCustomMetricId": { "description": "References a custom event metric. Mutually exclusive with standardEventId. Exactly one of these must be set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "order", "isPrimary" ], "additionalProperties": false } }, "currency": { "description": "Currency settings for price display and analytics calculations. Null inherits store default.", "anyOf": [ { "type": "object", "properties": { "code": { "default": "USD", "description": "ISO 4217 currency code used for analytics and price calculations.", "type": "string" }, "country": { "description": "ISO country code for locale-specific formatting.", "type": "string" }, "options": { "description": "Additional locale-specific formatting options." }, "symbol": { "default": "$", "description": "Display symbol prepended to amounts (e.g., '$', '\u20ac').", "type": "string" }, "suffix": { "description": "Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').", "type": "string" } }, "required": [ "code", "symbol" ], "additionalProperties": false }, { "type": "null" } ] }, "variations": { "default": [], "description": "Test variants including the control. One must be control; traffic percentages must sum to 100.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "name": { "type": "string", "description": "Display name (e.g., 'Control', 'Variant A'). Unique within the experience." }, "percentage": { "type": "number", "description": "Traffic allocation weight. All percentages across sibling variations must sum to 100." }, "isControl": { "default": false, "description": "The baseline variation all others are measured against. Exactly one per experience.", "type": "boolean" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order in the analytics dashboard. 0-indexed." }, "priceChange": { "description": "Price adjustment amount for pricing-type experiences. Positive increases price, negative discounts. Use priceChange for simple price A/B tests; use offer for structured discount campaigns (tiered, BOGO, free shipping).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priceChangeUnit": { "description": "How priceChange is applied: as a percentage of the original price or a fixed monetary amount.", "anyOf": [ { "type": "string", "enum": [ "percent", "dollar" ] }, { "type": "null" } ] }, "priceRoundingType": { "description": "Rounding strategy applied after priceChange (e.g., round up, round down, charm pricing).", "anyOf": [ { "type": "string", "enum": [ "none", "nearest", "up", "down" ] }, { "type": "null" } ] }, "priceRoundingAmount": { "description": "Target value for rounding (e.g., 0.99 for charm pricing like $X.99).", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onsiteEdits": { "default": [], "description": "DOM content modifications (text, HTML, image swaps, element removal). For CSS styling changes, use onsiteInjections instead.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "onsiteEditType": { "description": "Content modification strategy (html, text, image, or hide).", "anyOf": [ { "type": "string", "enum": [ "html", "text", "image", "hide" ] }, { "type": "null" } ] }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "find": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pattern to locate on the page. Interpreted as regex when isRegex is true." }, "title": { "description": "Dashboard label for identifying this edit.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRegex": { "default": false, "description": "When true, 'find' is treated as a regular expression.", "type": "boolean" }, "replace": { "default": "", "description": "Replacement content. Interpretation depends on onsiteEditType: HTML markup, plain text, or image URL.", "type": "string" }, "querySelectors": { "default": [ "" ], "description": "CSS selectors scoping which DOM elements this edit targets (e.g., '.product-title').", "type": "array", "items": { "type": "string" } }, "skip": { "default": false, "description": "When true, this edit is temporarily disabled without being deleted.", "type": "boolean" }, "remove": { "default": false, "description": "When true, the matched element is removed from the DOM instead of having its content replaced.", "type": "boolean" }, "groupId": { "description": "Groups related edits together so they can be managed as a unit.", "type": "string" }, "isHtml": { "default": false, "type": "boolean" }, "isImage": { "default": false, "type": "boolean" }, "insertType": { "anyOf": [ { "type": "string", "enum": [ "beforebegin", "afterbegin", "beforeend", "afterend" ] }, { "type": "null" } ], "description": "DOM insertion position relative to the target (beforebegin, afterbegin, beforeend, afterend). Null means content replacement." }, "createdAtUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Server-generated. Read-only. Storefront URL where this edit was originally created via the visual editor." }, "createdAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "imageSearchUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL pathname for locating images to replace. When set, images are found by URL match; when null, querySelectors is used instead." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "find", "isRegex", "replace", "querySelectors", "skip", "remove", "isHtml", "isImage", "insertType" ], "additionalProperties": false } }, "onsiteInjections": { "description": "CSS styling and custom JS injection. At most one per variation. For DOM content changes (text, images, HTML), use onsiteEdits instead.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "customCss": { "description": "CSS injected globally on the page when this variation is active.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customJs": { "description": "JavaScript executed on the page. Execution timing controlled by jsInjectionMode.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jsInjectionMode": { "type": "object", "properties": { "type": { "default": "immediately", "description": "Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.", "type": "string", "enum": [ "immediately", "onWindowLoad", "timeout" ] }, "timeout": { "description": "Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.", "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "type" ], "additionalProperties": false, "description": "Controls when customJs runs: immediately on load, after window load, or after a configurable delay." }, "source": { "anyOf": [ { "type": "string", "enum": [ "ai" ] }, { "type": "null" } ] } }, "required": [ "id", "variationId", "jsInjectionMode" ], "additionalProperties": false }, { "type": "null" } ] }, "offer": { "description": "Structured discount configuration (tiered volume discounts, cart-level discounts, gift-with-purchase, free shipping). Use offer for campaign/discount experiences; use priceChange for simple price A/B tests.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation this offer belongs to." }, "enabled": { "default": false, "description": "Whether the offer is actively applying discounts to customers on the storefront.", "type": "boolean" }, "isTest": { "default": false, "description": "When true, the offer exists in draft mode and is not applied to customers.", "type": "boolean" }, "isArchived": { "default": false, "description": "Whether the offer has been archived and is no longer active.", "type": "boolean" }, "name": { "type": "string", "description": "Internal label for identifying the offer in dashboards." }, "unitType": { "default": "dollar", "description": "Threshold basis for tiered discounts: per-item quantity or monetary amount spent.", "type": "string", "enum": [ "unit", "dollar" ] }, "discountType": { "default": "dollar", "description": "How the discount value is calculated (e.g., percentage off, fixed amount off).", "type": "string", "enum": [ "percentage", "dollar" ] }, "tiers": { "default": [], "description": "Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "minimumUnits": { "default": 1, "type": "number" }, "maximumUnits": { "default": 1, "type": "number" }, "unitDiscount": { "default": 1, "type": "number" }, "discountTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseTitle": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFreeShipping": { "default": false, "type": "boolean" }, "isGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseProductId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "giftWithPurchaseVariantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "autoAddGiftWithPurchase": { "default": false, "type": "boolean" }, "giftWithPurchaseHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "minimumUnits", "maximumUnits", "unitDiscount", "discountTitle", "giftWithPurchaseTitle", "isFreeShipping", "isGiftWithPurchase", "autoAddGiftWithPurchase" ], "additionalProperties": false } }, "maximumDollarDiscount": { "description": "Hard cap on the total dollar discount. Null means no cap is applied.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountApplicationType": { "type": "string", "enum": [ "tieredDiscount", "cartDiscount", "freeGift", "freeShipping", "" ], "description": "Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)." }, "discountApplicationMethod": { "type": "string", "enum": [ "perItem", "perOrder" ], "description": "Whether the discount applies per individual item or to the entire order." }, "combinesWithIntelligems": { "type": "boolean", "description": "Whether this offer stacks with other active Intelligems discounts." }, "combinesWithShopify": { "type": "boolean", "description": "Whether this offer stacks with native Shopify discount codes." }, "shouldRejectCodes": { "type": "boolean", "description": "When true, manual discount codes entered at checkout are rejected while this offer is active." }, "shippingDiscount": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "discountType": { "type": "string", "enum": [ "percentage", "dollar" ] }, "unitDiscount": { "type": "number" }, "rateFilter": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "amount" }, "amount": { "type": "number" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "name" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "is", "contains", "isNot", "doesNotContain", "startsWith", "doesNotStartWith" ] }, "name": { "type": "string" } }, "required": [ "id", "operator", "name" ], "additionalProperties": false } } }, "required": [ "type", "rules" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "countryFilter": { "anyOf": [ { "type": "object", "properties": { "allow": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ] }, "discountLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "discountType", "unitDiscount", "rateFilter", "countryFilter", "discountLabel" ], "additionalProperties": false }, { "type": "null" } ], "description": "Shipping discount details. Only present when discountApplicationType is freeShipping." }, "requireSameItem": { "default": false, "description": "For tiered discounts: when true, only multiples of the same product count toward thresholds.", "type": "boolean" }, "subscriptionApplicationType": { "default": "oneTime", "description": "Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).", "type": "string", "enum": [ "oneTime", "firstSub", "oneTimeAndFirstSub" ] } }, "required": [ "id", "variationId", "enabled", "isTest", "isArchived", "name", "unitType", "discountType", "tiers", "discountApplicationType", "discountApplicationMethod", "combinesWithIntelligems", "combinesWithShopify", "shouldRejectCodes", "shippingDiscount", "requireSameItem", "subscriptionApplicationType" ], "additionalProperties": false }, { "type": "null" } ] }, "offerId": { "description": "Server-generated. Read-only. References the associated offer. Populated when offer is set.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "shippingRateGroups": { "description": "Shipping rate overrides. Only populated for shipping test experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupType": { "type": "string", "enum": [ "flatRate", "flatRateWithThreshold", "thresholdOnly", "tieredByPriceOrWeight", "custom" ] }, "position": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "amount": { "type": "number" }, "rateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rateType": { "type": "string", "enum": [ "amount", "threshold", "tier" ] }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SRD", "STD", "SZL", "THB", "TJS", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "min": { "default": 0, "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, "conditionType": { "type": "string", "enum": [ "currency", "weight" ] }, "unit": { "anyOf": [ { "type": "string", "enum": [ "g", "kg", "lb", "oz" ] }, { "type": "null" } ] } }, "required": [ "min", "conditionType" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "amount", "rateType", "currency" ], "additionalProperties": false } }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "groupType", "position", "rates", "variationId" ], "additionalProperties": false } }, "excludeProducts": { "description": "When true, specific products are excluded from price changes. Use excludeProducts when most products should be tested and only a few excluded. Mutually exclusive with includeProducts.", "default": false, "type": "boolean" }, "includeProducts": { "description": "When true, only specific products receive price changes. Use includeProducts when only a few products should be tested. Mutually exclusive with excludeProducts.", "default": false, "type": "boolean" }, "testExperienceId": { "description": "Links to another experience for advanced multi-experience configurations.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "functionSyncError": { "default": false, "description": "Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.", "type": "boolean" }, "redirects": { "description": "URL redirect rules for content/url experiences.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "group": { "type": "number", "description": "Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "originUrl": { "type": "string", "description": "URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field." }, "destinationUrl": { "description": "Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "queryParams": { "default": [], "description": "Key-value pairs appended to the destination URL as query parameters.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Query parameter name appended to the destination URL." }, "value": { "type": "string", "description": "Query parameter value." } }, "required": [ "key", "value" ], "additionalProperties": false } }, "skip": { "type": "boolean", "description": "When true, this redirect is temporarily disabled." }, "isThemeTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify themes. Used with content/theme experiences." }, "isTemplateTest": { "type": "boolean", "description": "True when this redirect tests alternate Shopify templates. Used with content/template experiences." }, "templateType": { "description": "Shopify template type being tested (e.g., product, collection).", "anyOf": [ { "type": "string", "enum": [ "404", "", "article", "blog", "cart", "collection", "index", "list-collections", "page", "password", "product", "search" ] }, { "type": "null" } ] }, "templateSuffixes": { "default": [], "description": "Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "redirectOnce": { "default": false, "description": "When true, the redirect fires only once per visitor session to avoid redirect loops.", "type": "boolean" }, "filter": { "default": "matchesExactly", "description": "Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).", "type": "string", "enum": [ "matchesExactly", "contains", "endsWith", "matchesRegex", "none" ] }, "find": { "description": "Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirectType": { "default": "fullReplacement", "description": "fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.", "type": "string", "enum": [ "fullReplacement", "partialReplacement" ] } }, "required": [ "id", "group", "variationId", "originUrl", "queryParams", "skip", "isThemeTest", "isTemplateTest", "templateSuffixes", "redirectOnce", "filter", "redirectType" ], "additionalProperties": false } }, "userInterfaces": { "description": "UI widget configurations displayed for this variation.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "isEnabled": { "type": "boolean" }, "isArchived": { "default": false, "type": "boolean" }, "widget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "enabledSitewide": { "default": false, "type": "boolean" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "widgetType": { "type": "string", "enum": [ "messageBoxPopup", "messageBoxSlideOut", "quantityButtons", "discountProgressBar", "shippingProgressBar" ] }, "config": { "type": "object", "properties": { "desktop": {}, "mobile": {} }, "additionalProperties": false } }, "required": [ "id", "name", "enabledSitewide", "widgetType", "config" ], "additionalProperties": false }, "widgetId": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "quantityButtons", "progressBar", "messageBox" ] }, "variationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "desktopVariables": { "anyOf": [ {}, { "type": "null" } ] }, "mobileVariables": { "anyOf": [ {}, { "type": "null" } ] }, "styleOverrides": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "id", "isArchived", "widgetId" ], "additionalProperties": false } }, "checkoutBlocks": { "description": "Shopify checkout extensibility block configurations for this variation.", "default": [], "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "trustBadge" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "iconSize": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageSize": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 500 }, { "type": "null" } ] }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaSpacing": { "type": "string" } }, "required": [ "order", "type", "imageSize", "imageSizeUnit", "mediaSpacing" ], "additionalProperties": false } } }, "required": [ "headerText", "items" ], "additionalProperties": false, "description": "Configurable content for the trust badge (e.g., badge images, guarantee text)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "itemSubtitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "itemTitle", "itemSubtitle" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" } }, "required": [ "header", "item", "block" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "itemTitleText": { "type": "string" }, "itemSubtitleText": { "type": "string" } }, "required": [ "headerText", "itemTitleText", "itemSubtitleText" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "rowCount", "columnCount" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "itemBorderThickness": { "type": "string" }, "itemBorderStyle": { "default": "none", "type": "string" }, "itemCornerRadius": { "type": "string" }, "itemTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "itemBorderThickness", "itemBorderStyle", "itemCornerRadius", "itemTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the trust badge appearance." } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "upsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "maxProductLimit": { "default": 3, "type": "integer", "minimum": 1, "maximum": 10 }, "excludeItemsInCart": { "default": false, "type": "boolean" }, "excludeOutOfStock": { "default": false, "type": "boolean" }, "buttonText": { "type": "string" }, "imageSize": { "type": "number", "minimum": 1, "maximum": 500 }, "imageSizeUnit": { "type": "string", "enum": [ "pixels", "percentage" ] }, "imageAspectRatio": { "type": "string" }, "mediaSpacing": { "type": "string" } }, "required": [ "headerText", "maxProductLimit", "excludeItemsInCart", "excludeOutOfStock", "buttonText", "imageSize", "imageSizeUnit", "imageAspectRatio", "mediaSpacing" ], "additionalProperties": false, "description": "Configurable content for the upsell block (e.g., product selection, heading text, CTA label)." }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "header": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "variantTitle": { "default": { "fontSize": "base", "fontStyle": "normal" }, "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "header", "productTitle", "variantTitle", "price", "button" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "header": { "type": "string" }, "item": { "type": "string" }, "block": { "type": "string" }, "button": { "type": "string" }, "productUnit": { "type": "string" } }, "required": [ "header", "item", "block", "button", "productUnit" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "headerText": { "type": "string" }, "productText": { "type": "string" }, "variantText": { "default": "subdued", "type": "string" }, "priceText": { "type": "string" }, "carouselArrowColor": { "default": "monochrome", "type": "string" }, "carouselArrowStyle": { "default": "primary", "type": "string" } }, "required": [ "headerText", "productText", "variantText", "priceText", "carouselArrowColor", "carouselArrowStyle" ], "additionalProperties": false }, "layout": { "type": "object", "properties": { "headerTextAlign": { "type": "string" }, "bodyAlign": { "type": "string" }, "itemTextAlign": { "type": "string" }, "itemPositionAlign": { "type": "string" }, "mobile": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false }, "desktop": { "type": "object", "properties": { "rowCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "rowCount", "columnCount" ], "additionalProperties": false } }, "required": [ "headerTextAlign", "bodyAlign", "itemTextAlign", "itemPositionAlign", "mobile", "desktop" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "headerBorderThickness": { "type": "string" }, "headerBorderStyle": { "default": "none", "type": "string" }, "headerCornerRadius": { "type": "string" }, "headerPadding": { "type": "string" }, "bodySpacing": { "type": "string" }, "headingToBodySpacing": { "type": "string" }, "blockBorderThickness": { "type": "string" }, "blockBorderStyle": { "default": "none", "type": "string" }, "blockPadding": { "type": "string" }, "blockCornerRadius": { "type": "string" }, "productBorderThickness": { "type": "string" }, "productBorderStyle": { "default": "none", "type": "string" }, "productCornerRadius": { "type": "string" }, "productTextSpacing": { "type": "string" } }, "required": [ "headerBorderThickness", "headerBorderStyle", "headerCornerRadius", "headerPadding", "bodySpacing", "headingToBodySpacing", "blockBorderThickness", "blockBorderStyle", "blockPadding", "blockCornerRadius", "productBorderThickness", "productBorderStyle", "productCornerRadius", "productTextSpacing" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "layout", "appearance" ], "additionalProperties": false, "description": "CSS styling overrides for the upsell block appearance." }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent variation." }, "locationId": { "type": "string", "description": "Shopify checkout extensibility target location where the block renders." }, "blockType": { "type": "string", "const": "postPurchaseUpsell" }, "name": { "type": "string", "description": "Display name for identifying this block in the dashboard." }, "variables": { "type": "object", "properties": { "headerText": { "type": "string" }, "discountType": { "default": "none", "type": "string", "enum": [ "none", "percentage", "fixed" ] }, "discountValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "compareAtPriceDisplay": { "default": "none", "type": "string", "enum": [ "none", "compareAtPrice", "regularPrice" ] }, "imageAspectRatio": { "type": "string" }, "excludeOutOfStock": { "type": "boolean" }, "excludeItemsInCart": { "type": "boolean" }, "maxProductLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bannerEnabled": { "type": "boolean" }, "bannerTitle": { "type": "string" }, "bannerSubtitle": { "type": "string" }, "compareAtPriceEnabled": { "type": "boolean" }, "descriptionEnabled": { "type": "boolean" }, "quantitySelectorEnabled": { "type": "boolean" }, "quantityLabel": { "type": "string" }, "maxQuantityType": { "type": "string" }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "moneyLineEnabled": { "type": "boolean" }, "moneyLineSubtotal": { "type": "boolean" }, "moneyLineShipping": { "type": "boolean" }, "moneyLineTaxes": { "type": "boolean" }, "primaryButtonText": { "type": "string" }, "secondaryButtonEnabled": { "type": "boolean" }, "secondaryButtonText": { "type": "string" }, "headingLevel": { "type": "string" } }, "required": [ "headerText", "discountType", "compareAtPriceDisplay", "imageAspectRatio", "excludeOutOfStock", "excludeItemsInCart", "maxProductLimit", "bannerEnabled", "compareAtPriceEnabled", "descriptionEnabled", "quantitySelectorEnabled", "moneyLineEnabled", "moneyLineSubtotal", "moneyLineShipping", "moneyLineTaxes", "primaryButtonText", "secondaryButtonEnabled", "headingLevel" ], "additionalProperties": false }, "styles": { "type": "object", "properties": { "typography": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "productTitle": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "price": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "description": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "primaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false }, "secondaryButton": { "type": "object", "properties": { "fontSize": { "type": "string" }, "fontStyle": { "type": "string" } }, "required": [ "fontSize", "fontStyle" ], "additionalProperties": false } }, "required": [ "productTitle", "price", "primaryButton" ], "additionalProperties": false }, "backgroundColors": { "type": "object", "properties": { "banner": { "type": "string" }, "primaryButton": { "type": "string" }, "secondaryButton": { "type": "string" } }, "required": [ "banner", "primaryButton" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "bannerText": { "type": "string" }, "productText": { "type": "string" }, "priceText": { "type": "string" }, "descriptionText": { "type": "string" }, "primaryButtonText": { "type": "string" }, "secondaryButtonText": { "type": "string" } }, "required": [ "productText", "priceText", "primaryButtonText" ], "additionalProperties": false }, "appearance": { "type": "object", "properties": { "bannerBorderStyle": { "type": "string" }, "bannerSpacing": { "type": "string" }, "bannerTextAlign": { "type": "string" }, "separatorWidth": { "type": "string" }, "imageFit": { "type": "string" }, "imageBorder": { "type": "boolean" }, "pricingAppearance": { "type": "string" }, "pricingEmphasized": { "type": "boolean" }, "pricingSubduedStyle": { "type": "boolean" }, "descriptionSubdued": { "type": "boolean" }, "secondaryButtonStyle": { "type": "string" } }, "required": [ "bannerBorderStyle", "bannerSpacing", "bannerTextAlign", "separatorWidth", "imageFit", "imageBorder", "pricingEmphasized", "descriptionSubdued", "secondaryButtonStyle" ], "additionalProperties": false } }, "required": [ "typography", "backgroundColors", "colors", "appearance" ], "additionalProperties": false }, "upsellProductRules": { "default": [], "description": "Product selection and recommendation rules that determine which products to show in this upsell block.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "checkoutBlockId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cartTargeting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false }, "action": { "$ref": "#/components/schemas/__schema0" }, "variationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "checkoutBlockId", "priority", "cartTargeting", "action", "variationId" ], "additionalProperties": false } } }, "required": [ "id", "variationId", "locationId", "blockType", "name", "variables", "styles", "upsellProductRules" ], "additionalProperties": false } ], "type": "object" } }, "cartTargeting": { "description": "Cart-based targeting rules that determine when this variation is shown based on cart contents.", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "type": { "type": "string", "enum": [ "anything", "productId", "collection", "tag", "cartSubtotal", "cartItemCount" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude", "greaterThan", "lessThan", "equalTo", "greaterThanOrEqual", "lessThanOrEqual", "between" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] } }, "required": [ "variantId", "inclusionType" ], "additionalProperties": false } } } ] } }, "required": [ "key", "type", "filter" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } } }, "required": [ "id", "expression" ], "additionalProperties": false } } }, "required": [ "id", "experienceId", "name", "percentage", "isControl", "order", "onsiteEdits", "functionSyncError" ], "additionalProperties": false } }, "createdAtTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds." }, "isDeleted": { "description": "Whether this experience has been soft-deleted and hidden from default listings.", "type": "boolean" }, "shippingTestMethodDefinitions": { "default": [], "description": "Shipping rate configurations. Only populated for shipping test experiences.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deliveryProfileId": { "type": "string" }, "deliveryLocationGroupId": { "type": "string" }, "deliveryZoneId": { "type": "string" }, "methodDefinitionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canonicalMethodId": { "type": "string" }, "deleteTargetKind": { "type": "string", "enum": [ "canonical_method", "participant_method", "synthetic_free_condition", "synthetic_rate_definition" ] }, "deleteTargetRateDefinitionId": { "type": "string" }, "deleteTargetFreeCondition": { "type": "object", "properties": { "subject": { "type": "string" }, "min": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "__typename": { "type": "string", "const": "MoneyV2" }, "amount": { "type": "string" }, "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "__typename", "amount" ], "additionalProperties": false }, { "type": "object", "properties": { "__typename": { "type": "string", "const": "Weight" }, "unit": { "type": "string" }, "value": { "type": "number" } }, "required": [ "__typename", "unit", "value" ], "additionalProperties": false } ] }, { "type": "null" } ] } }, "required": [ "subject" ], "additionalProperties": false } }, "required": [ "deliveryProfileId", "deliveryLocationGroupId", "deliveryZoneId" ], "additionalProperties": false } }, "audience": { "description": "Visitor segmentation rules. Null means all visitors are eligible.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "experienceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "References the parent experience." }, "enabled": { "type": "boolean", "description": "When false, audience rules are ignored and all visitors are eligible." }, "excludeCurrency": { "type": "object", "properties": { "exclude": { "type": "boolean", "description": "Whether currency/geo-based exclusion is active." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 4217 currency code to exclude. Null disables currency-based exclusion." }, "country": { "description": "ISO country code to exclude visitors from.", "type": "string" }, "region": { "description": "Region or state code to exclude visitors from.", "type": "string" }, "city": { "description": "City name to exclude visitors from.", "type": "string" } }, "required": [ "exclude", "currency" ], "additionalProperties": false, "description": "Currency and geo-based visitor exclusion configuration." }, "wholesale": { "type": "boolean", "description": "Controls whether wholesale (B2B) customers are included in or excluded from the experience." }, "audienceType": { "description": "Complexity level of the targeting rules: common (prebuilt), custom (simple), or advanced (full expression trees).", "type": "string", "enum": [ "common", "custom", "advanced" ] }, "elseAction": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "Fallback for visitors matching no filter: 'randomVariation' assigns randomly across variations (most common), 'assignVariation' forces a specific variation (set elseVariationId), 'experienceExclude' removes them from the experience entirely, 'leaveUnassigned' skips assignment." }, "elseVariationId": { "description": "Variation to force-assign when elseAction is 'assignVariation'. Typically set to the control variation to default non-targeted visitors to baseline.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "elseExcludeFromAnalytics": { "default": false, "description": "When true, visitors who match no filter are tracked but excluded from analytics calculations.", "type": "boolean" }, "filters": { "default": [], "description": "Ordered filter rules evaluated from lowest priority value first (0-indexed). First matching filter determines visitor treatment.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Server-generated. Read-only." }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Evaluation order. 0-indexed. Filters with lower values are evaluated first." }, "action": { "anyOf": [ { "type": "string", "enum": [ "experienceInclude", "experienceExclude", "experienceUnassigned", "assignVariation", "randomVariation", "leaveUnassigned" ] }, { "type": "null" } ], "description": "What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly." }, "filterType": { "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ], "description": "Category of targeting rule (e.g., UTM parameters, device type, visitor type)." }, "expression": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "description": "Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')." }, "value": { "type": "string", "description": "Expected value to compare against the visitor's actual value for this key." }, "filter": { "description": "Comparison operator (e.g., equals, contains, startsWith).", "anyOf": [ { "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "doesNotEqual", "doesNotContain", "doesNotStartWith", "doesNotEndWith", "isNull", "isNotNull", "regex" ] }, { "type": "null" } ] }, "type": { "default": "utm", "description": "Category of the parameter being matched. Determines which keys are valid.", "type": "string", "enum": [ "utm", "url", "urlPath", "device", "visitor", "jsExpression", "trafficSource", "country", "referrer", "cookie", "klaviyo", "landingPage" ] } }, "required": [ "key", "value", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, { "type": "null" } ], "description": "Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both." }, "expressionType": { "description": "Whether this uses prebuilt common rules or custom expression logic.", "anyOf": [ { "type": "string", "enum": [ "common", "custom" ] }, { "type": "null" } ] }, "variationId": { "description": "Variation to assign when action is 'assignVariation'. References a variation in the parent experience.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "excludeFromAnalytics": { "default": false, "description": "When true, visitors matching this filter are excluded from analytics even if included in the experience.", "type": "boolean" } }, "required": [ "id", "priority", "action", "filterType", "excludeFromAnalytics" ], "additionalProperties": false } }, "evaluationFrequency": { "description": "How often (in seconds) to re-evaluate audience rules for a returning visitor. Controls targeting freshness.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "experienceId", "enabled", "excludeCurrency", "wholesale", "elseAction", "elseExcludeFromAnalytics", "filters" ], "additionalProperties": false }, { "type": "null" } ] }, "lastUpdateTs": { "type": "number", "description": "Server-generated. Read-only. Unix timestamp in seconds of the most recent modification." }, "previewPath": { "description": "Storefront URL path used when generating preview links (e.g., '/products/example').", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isExternal": { "description": "True if this experience was created and is managed via the external API rather than the dashboard.", "anyOf": [ { "default": false, "type": "boolean" }, { "type": "null" } ] }, "startedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if never started." }, "pausedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not currently paused." }, "archivedAtTs": { "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if not archived.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "requiresLink": { "default": false, "description": "When true, visitors must use a special link to enter the experience instead of being auto-assigned.", "type": "boolean" }, "linkBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Base URL for generating access links. Only populated when requiresLink is true." }, "endedAtTs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Server-generated. Read-only. Unix timestamp in seconds. Null if still active." }, "productVariantCount": { "default": 0, "description": "Server-generated. Read-only. Total product variants currently included in this experience.", "type": "number" }, "sourceExperienceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Present when this experience was duplicated or rolled out from another. References the original." }, "sourceAction": { "anyOf": [ { "type": "string", "enum": [ "duplicate", "rollout" ] }, { "type": "null" } ], "description": "How this experience was derived from sourceExperienceId. Only present when sourceExperienceId is set." }, "experienceAnalysis": { "type": "object", "properties": { "analyticsViewType": { "type": "string", "enum": [ "test_orders_only", "sitewide_orders", "none" ], "description": "Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted." } }, "required": [ "analyticsViewType" ], "additionalProperties": false } }, "required": [ "id", "name", "isPreview", "organizationId", "type", "category", "status", "testTypes", "experiencePageTargeting", "experienceProductTargeting", "experienceActions", "experienceIntegrations", "experienceCustomMetrics", "experienceKeyMetrics", "variations", "createdAtTs", "shippingTestMethodDefinitions", "lastUpdateTs", "startedAtTs", "pausedAtTs", "requiresLink", "linkBaseUrl", "endedAtTs", "productVariantCount", "experienceAnalysis" ], "additionalProperties": false, "description": "Full single-experience payload returned by GET /experiences/{experienceId}. Includes `experienceCustomMetrics`, `experienceIntegrations`, `experienceKeyMetrics`, and `shippingTestMethodDefinitions`. Unlike GET /experiences-list items, this response does not include `history`." }, { "type": "null" } ] } }, "required": [ "experience" ], "additionalProperties": false } } } } } } } }, "components": { "schemas": { "__schema0": { "type": "object", "properties": { "expression": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "shopifyRecommendations", "productId", "collection", "tag" ] }, "type": { "type": "string", "enum": [ "shopifyRecommendations", "productId", "collection", "tag" ] }, "filter": { "type": "string", "enum": [ "includes", "doesNotInclude" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "productId": { "type": "string" }, "productTitle": { "type": "string" }, "productImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "values" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "variantTitle": { "type": "string" }, "variantImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "number" }, "compareAtPrice": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currencyCode": { "type": "string" }, "availableForSale": { "type": "boolean" }, "inclusionType": { "type": "string", "enum": [ "include", "exclude" ] }, "variantOptions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "additionalProperties": false } } }, "required": [ "variantId", "variantTitle", "price", "inclusionType" ], "additionalProperties": false } } }, "required": [ "order", "productId", "productTitle", "variants" ], "additionalProperties": false } } ] } }, "required": [ "key", "type" ], "additionalProperties": false }, "operator": { "type": "string", "enum": [ "and", "or", "start_paren", "end_paren" ] } }, "additionalProperties": false } }, "discountType": { "default": "none", "type": "string", "enum": [ "none", "percentage", "fixed" ] }, "discountValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "compareAtPriceDisplay": { "default": "none", "type": "string", "enum": [ "none", "compareAtPrice", "regularPrice" ] }, "onAccept": { "anyOf": [ { "$ref": "#/components/schemas/__schema0" }, { "type": "null" } ] }, "onDecline": { "anyOf": [ { "$ref": "#/components/schemas/__schema0" }, { "type": "null" } ] } }, "required": [ "expression", "discountType", "compareAtPriceDisplay" ], "additionalProperties": false } }, "securitySchemes": { "intelligems_access_token": { "type": "apiKey", "in": "header", "name": "intelligems-access-token", "description": "Intelligems external API access token." } } } }