Fetch Experience Data

Deprecated

get

Retrieve analytics data for a specific experience, including metrics, variations, and optionally graph images.

This 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.

Authorizations

intelligems_access_token

intelligems-access-tokenstringRequired

Intelligems external API access token.

Query parameters

graphsstringOptional

Comma-separated list of graph IDs to include in response. Only applicable for "view=overview" requests. Available options:

• abandoned_cart_rate
• abandoned_checkout_rate
• add_to_cart_rate
• avg_discount_per_all_orders
• avg_discount_per_discounted_order
• avg_product_revenue_per_unit
• avg_units_per_order
• checkout_address_submitted_rate
• checkout_begin_rate
• checkout_enter_contact_info_rate
• conversion_rate
• net_product_revenue_per_order
• net_revenue_per_order
• net_revenue_per_visitor
• net_shipping_revenue_per_order
• pct_orders_free_shipping
• pct_subscription_orders
• profit_per_order
• profit_per_visitor
• subscription_orders_per_visitor
• subscription_product_revenue_per_order
• subscription_profit_per_visitor
• subscription_revenue_per_order
• subscription_revenue_per_visitor
• view_collection_page_rate
• view_product_page_rate

graphOutputstring · enumOptional

Output format for graph images. 'png' (default) uploads to S3 and returns a URL. 'base64' returns the raw base64-encoded PNG data inline.

Default: pngPossible values:

viewstring · enumOptionalDefault: overviewPossible values:

audiencestring · enumOptionalPossible values:

analyticsViewTypestring · enumOptionalPossible values:

endstringOptional

startstringOptional

Responses

200

OK

application/json

get

/v25-10-beta/analytics/resource/{experienceId}

Overview with date range + specific graph imagesAudience breakdown by device typeAudience breakdown by traffic source channel

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' \
--header 'content-type: application/json' \
--header 'intelligems-access-token: YOUR_API_KEY' \
--data ''

200

OK

{
  "datasetId": "order_line_items",
  "latestRunTs": 1,
  "metrics": [],
  "audienceOrder": null,
  "histogram": null,
  "kde": null,
  "cdf": null,
  "variations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "experienceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "percentage": 1,
      "isControl": false,
      "order": 1,
      "priceChange": "text",
      "priceChangeUnit": "percent",
      "priceRoundingType": "none",
      "priceRoundingAmount": "text",
      "onsiteEdits": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "onsiteEditType": "html",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "find": "text",
          "title": "text",
          "isRegex": false,
          "replace": "",
          "querySelectors": [
            "text"
          ],
          "skip": false,
          "remove": false,
          "groupId": "text",
          "isHtml": false,
          "isImage": false,
          "insertType": "beforebegin",
          "createdAtUrl": "text",
          "createdAtTs": 1,
          "imageSearchUrl": "text"
        }
      ],
      "onsiteInjections": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "variationId": "123e4567-e89b-12d3-a456-426614174000",
        "customCss": "text",
        "customJs": "text",
        "jsInjectionMode": {
          "type": "immediately",
          "timeout": 1
        }
      },
      "offer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "variationId": "123e4567-e89b-12d3-a456-426614174000",
        "enabled": false,
        "isTest": false,
        "isArchived": false,
        "name": "text",
        "unitType": "dollar",
        "discountType": "dollar",
        "tiers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "minimumUnits": 1,
            "maximumUnits": 1,
            "unitDiscount": 1,
            "discountTitle": "text",
            "giftWithPurchaseTitle": "text",
            "isFreeShipping": false,
            "isGiftWithPurchase": false,
            "giftWithPurchaseProductId": "text",
            "giftWithPurchaseVariantId": "text",
            "autoAddGiftWithPurchase": false,
            "giftWithPurchaseHandle": "text"
          }
        ],
        "maximumDollarDiscount": 1,
        "discountApplicationType": "tieredDiscount",
        "discountApplicationMethod": "perItem",
        "combinesWithIntelligems": true,
        "combinesWithShopify": true,
        "shouldRejectCodes": true,
        "shippingDiscount": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "discountType": "percentage",
          "unitDiscount": 1,
          "rateFilter": {
            "type": "text",
            "amount": 1
          },
          "countryFilter": {
            "allow": [
              "text"
            ],
            "exclude": [
              "text"
            ]
          },
          "discountLabel": "text"
        },
        "requireSameItem": false
      },
      "offerId": "123e4567-e89b-12d3-a456-426614174000",
      "shippingRateGroups": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "groupType": "flatRate",
          "position": 1,
          "rates": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "amount": 1,
              "rateCode": "text",
              "rateType": "amount",
              "currency": "AED",
              "condition": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "min": 0,
                "max": 1,
                "conditionType": "currency",
                "unit": "g"
              },
              "description": "text"
            }
          ],
          "variationId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "excludeProducts": false,
      "includeProducts": false,
      "testExperienceId": "text",
      "functionSyncError": false,
      "redirects": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "group": 1,
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "originUrl": "text",
          "destinationUrl": "text",
          "queryParams": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "skip": true,
          "isThemeTest": true,
          "isTemplateTest": true,
          "templateType": "404",
          "templateSuffixes": [
            "text"
          ],
          "redirectOnce": false,
          "filter": "matchesExactly",
          "find": "text",
          "redirectType": "fullReplacement"
        }
      ],
      "userInterfaces": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "isEnabled": true,
          "isArchived": false,
          "widget": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "enabledSitewide": false,
            "parentId": "123e4567-e89b-12d3-a456-426614174000",
            "widgetType": "messageBoxPopup",
            "config": {
              "desktop": null,
              "mobile": null
            }
          },
          "widgetId": "text",
          "category": "quantityButtons",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "desktopVariables": null,
          "mobileVariables": null,
          "styleOverrides": null
        }
      ],
      "checkoutBlocks": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "locationId": "text",
          "blockType": "text",
          "name": "text",
          "variables": {
            "headerText": "text",
            "items": [
              {
                "order": 1,
                "title": "text",
                "subtitle": "text",
                "type": "text",
                "icon": "text",
                "iconColor": "text",
                "iconSize": "text",
                "imageSize": 1,
                "imageAspectRatio": "text",
                "image": "text",
                "mediaSpacing": "text"
              }
            ]
          },
          "styles": {
            "typography": {
              "header": {
                "fontSize": "text",
                "fontStyle": "text"
              },
              "itemTitle": {
                "fontSize": "text",
                "fontStyle": "text"
              },
              "itemSubtitle": {
                "fontSize": "text",
                "fontStyle": "text"
              }
            },
            "backgroundColors": {
              "header": "text",
              "item": "text",
              "block": "text"
            },
            "colors": {
              "headerText": "text",
              "itemTitleText": "text",
              "itemSubtitleText": "text"
            },
            "layout": {
              "headerTextAlign": "text",
              "bodyAlign": "text",
              "itemTextAlign": "text",
              "itemPositionAlign": "text",
              "rowCount": 1,
              "columnCount": 1
            },
            "appearance": {
              "headerBorderThickness": "text",
              "headerBorderStyle": "none",
              "headerCornerRadius": "text",
              "headerPadding": "text",
              "bodySpacing": "text",
              "headingToBodySpacing": "text",
              "blockBorderThickness": "text",
              "blockBorderStyle": "none",
              "blockPadding": "text",
              "blockCornerRadius": "text",
              "itemBorderThickness": "text",
              "itemBorderStyle": "none",
              "itemCornerRadius": "text",
              "itemTextSpacing": "text"
            }
          }
        }
      ],
      "cartTargeting": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "expression": [
            {
              "query": {
                "key": "anything",
                "type": "anything",
                "filter": "includes",
                "value": "text"
              },
              "operator": "and"
            }
          ]
        }
      ]
    }
  ],
  "graphs": [
    {
      "id": "text",
      "key": "text",
      "url": "text",
      "data": "text",
      "type": "text",
      "title": "text"
    }
  ],
  "experienceId": "123e4567-e89b-12d3-a456-426614174000",
  "experienceName": "text",
  "impact": {
    "est_monthly_revenue_increase": 1
  }
}

post

Analyze analytics data for a specific experience using a POST request body for filters and request settings.

The 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.

Use startTs and endTs in the request body to match the backend contract. Use the filters object for all advanced filtering instead of query parameters.

Authorizations

intelligems_access_token

intelligems-access-tokenstringRequired

Intelligems external API access token.

Body

application/json

viewstring · enumOptional

Resource view to analyze. Use 'overview' for variation-level metrics or 'audience' for a breakdown by the selected audience dimension.

Default: overviewPossible values:

audiencestring · enumOptional

Audience breakdown dimension returned when view is audience. Use one of the supported audience fields such as device_type, visitor_type, or source_channel.

Possible values:

analyticsViewTypestring · enumOptional

Optional analytics view preset used by the backend when building the analysis request.

Possible values:

endTsstringOptional

Optional analysis end timestamp as a 10-digit Unix epoch in seconds. Maps directly to the backend endTs field.

startTsstringOptional

Optional analysis start timestamp as a 10-digit Unix epoch in seconds. Maps directly to the backend startTs field.

Responses

200

OK

application/json

post

/v25-10-beta/analytics/resource/{experienceId}

Overview with date range + specific graph imagesAudience breakdown by device typeFilter by device type and countryFilter by traffic source and landing page

curl --location 'https://api.intelligems.io/v25-10-beta/analytics/resource/a1a1a1a1-a1a1-1111-aaaa-aa1111111111' \
--header 'content-type: application/json' \
--header 'intelligems-access-token: YOUR_API_KEY' \
--data '{
  "startTs": "1764199800",
  "endTs": "1764223200",
  "graphs": {
    "ids": ["conversion_rate", "net_revenue_per_visitor", "add_to_cart_rate"],
    "outputFormat": "png"
  }
}'

200

OK

{
  "datasetId": "order_line_items",
  "latestRunTs": 1,
  "metrics": [],
  "audienceOrder": null,
  "histogram": null,
  "kde": null,
  "cdf": null,
  "variations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "experienceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "percentage": 1,
      "isControl": false,
      "order": 1,
      "priceChange": "text",
      "priceChangeUnit": "percent",
      "priceRoundingType": "none",
      "priceRoundingAmount": "text",
      "onsiteEdits": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "onsiteEditType": "html",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "find": "text",
          "title": "text",
          "isRegex": false,
          "replace": "",
          "querySelectors": [
            "text"
          ],
          "skip": false,
          "remove": false,
          "groupId": "text",
          "isHtml": false,
          "isImage": false,
          "insertType": "beforebegin",
          "createdAtUrl": "text",
          "createdAtTs": 1,
          "imageSearchUrl": "text"
        }
      ],
      "onsiteInjections": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "variationId": "123e4567-e89b-12d3-a456-426614174000",
        "customCss": "text",
        "customJs": "text",
        "jsInjectionMode": {
          "type": "immediately",
          "timeout": 1
        }
      },
      "offer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "variationId": "123e4567-e89b-12d3-a456-426614174000",
        "enabled": false,
        "isTest": false,
        "isArchived": false,
        "name": "text",
        "unitType": "dollar",
        "discountType": "dollar",
        "tiers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "minimumUnits": 1,
            "maximumUnits": 1,
            "unitDiscount": 1,
            "discountTitle": "text",
            "giftWithPurchaseTitle": "text",
            "isFreeShipping": false,
            "isGiftWithPurchase": false,
            "giftWithPurchaseProductId": "text",
            "giftWithPurchaseVariantId": "text",
            "autoAddGiftWithPurchase": false,
            "giftWithPurchaseHandle": "text"
          }
        ],
        "maximumDollarDiscount": 1,
        "discountApplicationType": "tieredDiscount",
        "discountApplicationMethod": "perItem",
        "combinesWithIntelligems": true,
        "combinesWithShopify": true,
        "shouldRejectCodes": true,
        "shippingDiscount": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "discountType": "percentage",
          "unitDiscount": 1,
          "rateFilter": {
            "type": "text",
            "amount": 1
          },
          "countryFilter": {
            "allow": [
              "text"
            ],
            "exclude": [
              "text"
            ]
          },
          "discountLabel": "text"
        },
        "requireSameItem": false
      },
      "offerId": "123e4567-e89b-12d3-a456-426614174000",
      "shippingRateGroups": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "groupType": "flatRate",
          "position": 1,
          "rates": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "amount": 1,
              "rateCode": "text",
              "rateType": "amount",
              "currency": "AED",
              "condition": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "min": 0,
                "max": 1,
                "conditionType": "currency",
                "unit": "g"
              },
              "description": "text"
            }
          ],
          "variationId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "excludeProducts": false,
      "includeProducts": false,
      "testExperienceId": "text",
      "functionSyncError": false,
      "redirects": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "group": 1,
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "originUrl": "text",
          "destinationUrl": "text",
          "queryParams": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "skip": true,
          "isThemeTest": true,
          "isTemplateTest": true,
          "templateType": "404",
          "templateSuffixes": [
            "text"
          ],
          "redirectOnce": false,
          "filter": "matchesExactly",
          "find": "text",
          "redirectType": "fullReplacement"
        }
      ],
      "userInterfaces": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "isEnabled": true,
          "isArchived": false,
          "widget": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "enabledSitewide": false,
            "parentId": "123e4567-e89b-12d3-a456-426614174000",
            "widgetType": "messageBoxPopup",
            "config": {
              "desktop": null,
              "mobile": null
            }
          },
          "widgetId": "text",
          "category": "quantityButtons",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "desktopVariables": null,
          "mobileVariables": null,
          "styleOverrides": null
        }
      ],
      "checkoutBlocks": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "locationId": "text",
          "blockType": "text",
          "name": "text",
          "variables": {
            "headerText": "text",
            "items": [
              {
                "order": 1,
                "title": "text",
                "subtitle": "text",
                "type": "text",
                "icon": "text",
                "iconColor": "text",
                "iconSize": "text",
                "imageSize": 1,
                "imageAspectRatio": "text",
                "image": "text",
                "mediaSpacing": "text"
              }
            ]
          },
          "styles": {
            "typography": {
              "header": {
                "fontSize": "text",
                "fontStyle": "text"
              },
              "itemTitle": {
                "fontSize": "text",
                "fontStyle": "text"
              },
              "itemSubtitle": {
                "fontSize": "text",
                "fontStyle": "text"
              }
            },
            "backgroundColors": {
              "header": "text",
              "item": "text",
              "block": "text"
            },
            "colors": {
              "headerText": "text",
              "itemTitleText": "text",
              "itemSubtitleText": "text"
            },
            "layout": {
              "headerTextAlign": "text",
              "bodyAlign": "text",
              "itemTextAlign": "text",
              "itemPositionAlign": "text",
              "rowCount": 1,
              "columnCount": 1
            },
            "appearance": {
              "headerBorderThickness": "text",
              "headerBorderStyle": "none",
              "headerCornerRadius": "text",
              "headerPadding": "text",
              "bodySpacing": "text",
              "headingToBodySpacing": "text",
              "blockBorderThickness": "text",
              "blockBorderStyle": "none",
              "blockPadding": "text",
              "blockCornerRadius": "text",
              "itemBorderThickness": "text",
              "itemBorderStyle": "none",
              "itemCornerRadius": "text",
              "itemTextSpacing": "text"
            }
          }
        }
      ],
      "cartTargeting": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "expression": [
            {
              "query": {
                "key": "anything",
                "type": "anything",
                "filter": "includes",
                "value": "text"
              },
              "operator": "and"
            }
          ]
        }
      ]
    }
  ],
  "graphs": [
    {
      "id": "text",
      "key": "text",
      "url": "text",
      "data": "text",
      "type": "text",
      "title": "text"
    }
  ],
  "experienceId": "123e4567-e89b-12d3-a456-426614174000",
  "experienceName": "text",
  "impact": {
    "est_monthly_revenue_increase": 1
  }
}

get

Authorizations

intelligems_access_token

intelligems-access-tokenstringRequired

Intelligems external API access token.

Query parameters

categorystring · enumOptional

Filter by experience category. Omit to return all categories.

Possible values:

statusstring · enumOptional

Filter by lifecycle status. Omit to return all statuses.

Possible values:

limitany ofOptional

Maximum number of experiences per page.

numberOptional

or

stringOptional

pageany ofOptional

1-based page number for paginated results.

numberOptional

or

stringOptional

randombooleanOptional

Responses

200

OK

application/json

get

/v25-10-beta/experiences-list

List all started experiments (paginated)List all active personalizations

curl --location 'https://api.intelligems.io/v25-10-beta/experiences-list?category=experiment&status=started&limit=20&page=1' \
--header 'content-type: application/json' \
--header 'intelligems-access-token: YOUR_API_KEY' \
--data ''

200

OK

{
  "experiencesList": [
    {
      "archivedAtTs": 1,
      "audience": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "enabled": true,
        "excludeCurrency": {
          "exclude": true,
          "currency": "text",
          "country": "text",
          "region": "text",
          "city": "text"
        },
        "wholesale": true,
        "audienceType": "common",
        "elseAction": "experienceInclude",
        "elseVariationId": "123e4567-e89b-12d3-a456-426614174000",
        "elseExcludeFromAnalytics": false,
        "filters": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "priority": 1,
            "action": "experienceInclude",
            "filterType": "utm",
            "expression": [
              {
                "query": {
                  "key": "text",
                  "value": "text",
                  "filter": "equals",
                  "type": "utm"
                },
                "operator": "and"
              }
            ],
            "expressionType": "common",
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "excludeFromAnalytics": false
          }
        ],
        "evaluationFrequency": 1
      },
      "category": "experiment",
      "createdAtTs": 1,
      "currency": {
        "code": "USD",
        "country": "text",
        "options": null,
        "symbol": "$",
        "suffix": "text"
      },
      "description": "text",
      "devicePreview": {
        "device": "desktop",
        "path": "/"
      },
      "endedAtTs": 1,
      "experienceActions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "experienceId": "123e4567-e89b-12d3-a456-426614174000",
          "action": "start",
          "actionTs": 1
        }
      ],
      "experiencePageTargeting": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "filter": "equals",
          "filterType": "url",
          "value": "text",
          "order": 1,
          "expression": [
            {
              "query": {
                "key": "text",
                "value": "text",
                "filter": "equals",
                "type": "utm"
              },
              "operator": "and"
            }
          ],
          "experienceId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "experienceProductTargeting": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "experienceId": "123e4567-e89b-12d3-a456-426614174000",
          "target": "productPage",
          "expression": [
            {
              "query": {
                "key": "productId",
                "value": "text",
                "filter": "includes",
                "type": "productId"
              },
              "operator": "and"
            }
          ]
        }
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isDeleted": true,
      "isExternal": false,
      "isPreview": true,
      "lastUpdateTs": 1,
      "linkBaseUrl": "text",
      "name": "text",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "pausedAtTs": 1,
      "productVariantCount": 0,
      "requiresLink": false,
      "sourceAction": "duplicate",
      "sourceExperienceId": "123e4567-e89b-12d3-a456-426614174000",
      "startedAtTs": 1,
      "status": "pending",
      "testTypes": {
        "hasTestPricing": true,
        "hasTestShipping": true,
        "hasTestCampaign": true,
        "hasTestContent": true,
        "hasTestContentUrl": true,
        "hasTestContentAdvanced": true,
        "hasTestContentOnsite": true,
        "hasTestContentTemplate": true,
        "hasTestContentTheme": true,
        "hasTestOnsiteInjections": true,
        "hasTestCheckoutBlocks": true
      },
      "type": "content/advanced",
      "history": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "user": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "firstName": "text",
            "lastName": "text",
            "email": "[email protected]",
            "organizationId": "123e4567-e89b-12d3-a456-426614174000",
            "isBlocked": true,
            "showInfoPopup": true,
            "userAlerts": {
              "showAnalyticsReleaseDialog": false,
              "showPersonalizationsDialog": false,
              "showPersonalizationMigrateBanner": false,
              "showWrappedDialog": true
            },
            "showWelcome": true,
            "preferredName": "text",
            "preferredEmail": "text",
            "installer": false,
            "companyRole": "text",
            "previousExperience": "text"
          },
          "experienceId": "123e4567-e89b-12d3-a456-426614174000",
          "action": "startExperience",
          "lastUpdateTs": 1,
          "createdAtTs": 1
        }
      ],
      "previewPath": "text",
      "variations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "experienceId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "percentage": 1,
          "isControl": false,
          "order": 1,
          "functionSyncError": false,
          "testExperienceId": "text",
          "offerId": "123e4567-e89b-12d3-a456-426614174000",
          "redirects": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "group": 1,
              "variationId": "123e4567-e89b-12d3-a456-426614174000",
              "originUrl": "text",
              "destinationUrl": "text",
              "queryParams": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "skip": true,
              "isThemeTest": true,
              "isTemplateTest": true,
              "templateType": "404",
              "templateSuffixes": [
                "text"
              ],
              "redirectOnce": false,
              "filter": "matchesExactly",
              "find": "text",
              "redirectType": "fullReplacement"
            }
          ]
        }
      ],
      "organization": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "shopId": "text",
        "orderCount": 1
      },
      "experienceAnalysis": {
        "analyticsViewType": "test_orders_only"
      }
    }
  ],
  "page": 1
}

get

Authorizations

intelligems_access_token

intelligems-access-tokenstringRequired

Intelligems external API access token.

Path parameters

experienceIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

OK

application/json

get

/v25-10-beta/experiences/{experienceId}

HTTPcURLJavaScriptPython

GET /v25-10-beta/experiences/{experienceId} HTTP/1.1
intelligems-access-token: YOUR_API_KEY
Accept: */*

200

OK

{
  "experience": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "isPreview": true,
    "description": "text",
    "devicePreview": {
      "device": "desktop",
      "path": "/"
    },
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "content/advanced",
    "category": "experiment",
    "status": "pending",
    "testTypes": {
      "hasTestPricing": true,
      "hasTestShipping": true,
      "hasTestCampaign": true,
      "hasTestContent": true,
      "hasTestContentUrl": true,
      "hasTestContentAdvanced": true,
      "hasTestContentOnsite": true,
      "hasTestContentTemplate": true,
      "hasTestContentTheme": true,
      "hasTestOnsiteInjections": true,
      "hasTestCheckoutBlocks": true
    },
    "experiencePageTargeting": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "filter": "equals",
        "filterType": "url",
        "value": "text",
        "order": 1,
        "expression": [
          {
            "query": {
              "key": "text",
              "value": "text",
              "filter": "equals",
              "type": "utm"
            },
            "operator": "and"
          }
        ],
        "experienceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "experienceProductTargeting": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "target": "productPage",
        "expression": [
          {
            "query": {
              "key": "productId",
              "value": "text",
              "filter": "includes",
              "type": "productId"
            },
            "operator": "and"
          }
        ]
      }
    ],
    "experienceActions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "action": "start",
        "actionTs": 1
      }
    ],
    "experienceIntegrations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAtTs": 1,
        "integration": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Recharge",
          "description": "text",
          "enabled": true,
          "globalSettings": null,
          "apis": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "description": "text",
              "accessToken": "text",
              "scopes": [
                "read_experiments"
              ],
              "organization": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text"
              }
            }
          ],
          "createdAtTs": 1,
          "lastUpdateTs": 1
        },
        "experienceSettings": null,
        "enabled": false
      }
    ],
    "experienceCustomMetrics": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "order": 1,
        "customEventId": "123e4567-e89b-12d3-a456-426614174000",
        "customEvent": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifier": "text",
          "name": "text",
          "description": "text",
          "eventCountLastDay": 1,
          "lastEventTs": 1,
          "error": "text",
          "createdAtTs": 1,
          "archivedAtTs": 1,
          "applyToUrls": [
            {
              "matchBy": "equals",
              "value": "text",
              "error": "text"
            }
          ],
          "experiencesList": [
            "text"
          ],
          "type": "text",
          "settings": {}
        }
      }
    ],
    "experienceKeyMetrics": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "order": 1,
        "isPrimary": false,
        "standardEventId": "conversionRate",
        "experienceCustomMetricId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "currency": {
      "code": "USD",
      "country": "text",
      "options": null,
      "symbol": "$",
      "suffix": "text"
    },
    "variations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "percentage": 1,
        "isControl": false,
        "order": 1,
        "priceChange": "text",
        "priceChangeUnit": "percent",
        "priceRoundingType": "none",
        "priceRoundingAmount": "text",
        "onsiteEdits": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "onsiteEditType": "html",
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "find": "text",
            "title": "text",
            "isRegex": false,
            "replace": "",
            "querySelectors": [
              "text"
            ],
            "skip": false,
            "remove": false,
            "groupId": "text",
            "isHtml": false,
            "isImage": false,
            "insertType": "beforebegin",
            "createdAtUrl": "text",
            "createdAtTs": 1,
            "imageSearchUrl": "text"
          }
        ],
        "onsiteInjections": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "customCss": "text",
          "customJs": "text",
          "jsInjectionMode": {
            "type": "immediately",
            "timeout": 1
          }
        },
        "offer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "enabled": false,
          "isTest": false,
          "isArchived": false,
          "name": "text",
          "unitType": "dollar",
          "discountType": "dollar",
          "tiers": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "minimumUnits": 1,
              "maximumUnits": 1,
              "unitDiscount": 1,
              "discountTitle": "text",
              "giftWithPurchaseTitle": "text",
              "isFreeShipping": false,
              "isGiftWithPurchase": false,
              "giftWithPurchaseProductId": "text",
              "giftWithPurchaseVariantId": "text",
              "autoAddGiftWithPurchase": false,
              "giftWithPurchaseHandle": "text"
            }
          ],
          "maximumDollarDiscount": 1,
          "discountApplicationType": "tieredDiscount",
          "discountApplicationMethod": "perItem",
          "combinesWithIntelligems": true,
          "combinesWithShopify": true,
          "shouldRejectCodes": true,
          "shippingDiscount": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "discountType": "percentage",
            "unitDiscount": 1,
            "rateFilter": {
              "type": "text",
              "amount": 1
            },
            "countryFilter": {
              "allow": [
                "text"
              ],
              "exclude": [
                "text"
              ]
            },
            "discountLabel": "text"
          },
          "requireSameItem": false
        },
        "offerId": "123e4567-e89b-12d3-a456-426614174000",
        "shippingRateGroups": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "groupType": "flatRate",
            "position": 1,
            "rates": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text",
                "amount": 1,
                "rateCode": "text",
                "rateType": "amount",
                "currency": "AED",
                "condition": {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "min": 0,
                  "max": 1,
                  "conditionType": "currency",
                  "unit": "g"
                },
                "description": "text"
              }
            ],
            "variationId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "excludeProducts": false,
        "includeProducts": false,
        "testExperienceId": "text",
        "functionSyncError": false,
        "redirects": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "group": 1,
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "originUrl": "text",
            "destinationUrl": "text",
            "queryParams": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "skip": true,
            "isThemeTest": true,
            "isTemplateTest": true,
            "templateType": "404",
            "templateSuffixes": [
              "text"
            ],
            "redirectOnce": false,
            "filter": "matchesExactly",
            "find": "text",
            "redirectType": "fullReplacement"
          }
        ],
        "userInterfaces": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "isEnabled": true,
            "isArchived": false,
            "widget": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "enabledSitewide": false,
              "parentId": "123e4567-e89b-12d3-a456-426614174000",
              "widgetType": "messageBoxPopup",
              "config": {
                "desktop": null,
                "mobile": null
              }
            },
            "widgetId": "text",
            "category": "quantityButtons",
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "desktopVariables": null,
            "mobileVariables": null,
            "styleOverrides": null
          }
        ],
        "checkoutBlocks": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "locationId": "text",
            "blockType": "text",
            "name": "text",
            "variables": {
              "headerText": "text",
              "items": [
                {
                  "order": 1,
                  "title": "text",
                  "subtitle": "text",
                  "type": "text",
                  "icon": "text",
                  "iconColor": "text",
                  "iconSize": "text",
                  "imageSize": 1,
                  "imageAspectRatio": "text",
                  "image": "text",
                  "mediaSpacing": "text"
                }
              ]
            },
            "styles": {
              "typography": {
                "header": {
                  "fontSize": "text",
                  "fontStyle": "text"
                },
                "itemTitle": {
                  "fontSize": "text",
                  "fontStyle": "text"
                },
                "itemSubtitle": {
                  "fontSize": "text",
                  "fontStyle": "text"
                }
              },
              "backgroundColors": {
                "header": "text",
                "item": "text",
                "block": "text"
              },
              "colors": {
                "headerText": "text",
                "itemTitleText": "text",
                "itemSubtitleText": "text"
              },
              "layout": {
                "headerTextAlign": "text",
                "bodyAlign": "text",
                "itemTextAlign": "text",
                "itemPositionAlign": "text",
                "rowCount": 1,
                "columnCount": 1
              },
              "appearance": {
                "headerBorderThickness": "text",
                "headerBorderStyle": "none",
                "headerCornerRadius": "text",
                "headerPadding": "text",
                "bodySpacing": "text",
                "headingToBodySpacing": "text",
                "blockBorderThickness": "text",
                "blockBorderStyle": "none",
                "blockPadding": "text",
                "blockCornerRadius": "text",
                "itemBorderThickness": "text",
                "itemBorderStyle": "none",
                "itemCornerRadius": "text",
                "itemTextSpacing": "text"
              }
            }
          }
        ],
        "cartTargeting": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "expression": [
              {
                "query": {
                  "key": "anything",
                  "type": "anything",
                  "filter": "includes",
                  "value": "text"
                },
                "operator": "and"
              }
            ]
          }
        ]
      }
    ],
    "createdAtTs": 1,
    "isDeleted": true,
    "shippingTestMethodDefinitions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "deliveryProfileId": "text",
        "deliveryLocationGroupId": "text",
        "deliveryZoneId": "text",
        "methodDefinitionId": "text"
      }
    ],
    "audience": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "experienceId": "123e4567-e89b-12d3-a456-426614174000",
      "enabled": true,
      "excludeCurrency": {
        "exclude": true,
        "currency": "text",
        "country": "text",
        "region": "text",
        "city": "text"
      },
      "wholesale": true,
      "audienceType": "common",
      "elseAction": "experienceInclude",
      "elseVariationId": "123e4567-e89b-12d3-a456-426614174000",
      "elseExcludeFromAnalytics": false,
      "filters": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "priority": 1,
          "action": "experienceInclude",
          "filterType": "utm",
          "expression": [
            {
              "query": {
                "key": "text",
                "value": "text",
                "filter": "equals",
                "type": "utm"
              },
              "operator": "and"
            }
          ],
          "expressionType": "common",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "excludeFromAnalytics": false
        }
      ],
      "evaluationFrequency": 1
    },
    "lastUpdateTs": 1,
    "previewPath": "text",
    "isExternal": false,
    "startedAtTs": 1,
    "pausedAtTs": 1,
    "archivedAtTs": 1,
    "requiresLink": false,
    "linkBaseUrl": "text",
    "endedAtTs": 1,
    "productVariantCount": 0,
    "sourceExperienceId": "123e4567-e89b-12d3-a456-426614174000",
    "sourceAction": "duplicate",
    "experienceAnalysis": {
      "analyticsViewType": "test_orders_only"
    }
  }
}