Available Endpoints
This is the authoritative list of endpoints. It is validated against the registered routes by an automated test, so it stays in sync and should not drift from the detailed per-endpoint pages.
Experiences
GET /v25-10-beta/experiences-list— Retrieve a paginated list of experiences with optional filtering bycategory,status, andmoduleGET /v25-10-beta/experiences/{experienceId}— Get complete details for a specific experiencePOST /v25-10-beta/experiences— Create a new experience or experimentPUT /v25-10-beta/experiences/{experienceId}— Update an existing experience's configuration, variations, or targetingGET /v25-10-beta/experiences/{experienceId}/offer-products— List the products an experience's offers apply to, with an optionalvariationIdfilterPOST /v25-10-beta/experiences/{experienceId}/actions/{action}— Perform a lifecycle action on an experience (start,pause, orend)
Experience & Experiment Analytics
POST /v25-10-beta/analytics/resource/{experienceId}— Retrieve analytics for an experience (metrics, variations, optional graphs). Accepts filters and all request settings in the JSON body. Use this for all new integrations.POST /v25-10-beta/analytics/experience/{experienceId}/timeseries— Metric-over-time data for a single experiencePOST /v25-10-beta/analytics/experience/{experienceId}/export— Export an experience's analytics datasetGET /v25-10-beta/analytics/resource/{experienceId}— Deprecated. Legacy query-parameter analytics endpoint, kept only as a beta compatibility path and removed when the beta ends. Use the POST variant above instead.
Sitewide Analytics
POST /v25-10-beta/analytics/sitewide/snapshot— Summary KPI metrics with period-over-period percent changes and optional audience segmentationPOST /v25-10-beta/analytics/sitewide/timeseries— Metric-over-time data with configurable granularity and optional audience segmentationPOST /v25-10-beta/analytics/sitewide/order-distribution— Order-value histogram (KDE/CDF) and unit-mix breakdownPOST /v25-10-beta/analytics/sitewide/conversion-funnel— Sitewide conversion funnel as a Sankey graph (entry point → landing page → cart → checkout → conversion)
Holiday Benchmark
POST /v25-10-beta/analytics/event/snapshot— Benchmark event snapshot metricsPOST /v25-10-beta/analytics/event/timeseries— Benchmark event metric-over-time data
Checkout Blocks
GET /v25-10-beta/experiences/{experienceId}/checkout-blocks— List an experience's checkout blocks, grouped by variation, with optionalvariationIdandblockTypefiltersPOST /v25-10-beta/experiences/{experienceId}/checkout-blocks— Add a checkout block (trust badge, upsell, shipping progress bar, timer, FAQs, or post-purchase upsell) to a variationPUT /v25-10-beta/experiences/{experienceId}/checkout-blocks/{blockId}— Replace a checkout block's content (a post-purchase upsell merges instead)DELETE /v25-10-beta/experiences/{experienceId}/checkout-blocks/{blockId}— Delete a checkout block
Custom Events
PUT /v25-10-beta/custom-events— Create a new custom event (click, scroll depth, page view, etc.), or update an existing one in place by passing back itsid
Agentic Logic
GET /v25-10-beta/agentic-logic/rulesPOST /v25-10-beta/agentic-logic/rulesGET /v25-10-beta/agentic-logic/rules/{ruleId}PATCH /v25-10-beta/agentic-logic/rules/{ruleId}DELETE /v25-10-beta/agentic-logic/rules/{ruleId}GET /v25-10-beta/agentic-logic/rules/{ruleId}/draftPUT /v25-10-beta/agentic-logic/rules/{ruleId}/draftPOST /v25-10-beta/agentic-logic/rules/{ruleId}/draft/validateGET /v25-10-beta/agentic-logic/rules/{ruleId}/versionsGET /v25-10-beta/agentic-logic/rules/{ruleId}/versions/{version}GET /v25-10-beta/agentic-logic/rules/{ruleId}/scenariosPOST /v25-10-beta/agentic-logic/rules/{ruleId}/evaluate-scenarioPOST /v25-10-beta/agentic-logic/rules/{ruleId}/actions/{action}POST /v25-10-beta/agentic-logic/rules/{ruleId}/publishPOST /v25-10-beta/agentic-logic/rules/{ruleId}/run-gatesPOST /v25-10-beta/agentic-logic/rules/{ruleId}/cancel-checksGET /v25-10-beta/agentic-logic/rules/{ruleId}/publish-jobs/{jobId}PUT /v25-10-beta/agentic-logic/system-rules/{systemKey}GET /v25-10-beta/agentic-logic/placementsPOST /v25-10-beta/agentic-logic/placementsPATCH /v25-10-beta/agentic-logic/placements/{placementId}DELETE /v25-10-beta/agentic-logic/placements/{placementId}GET /v25-10-beta/agentic-logic/assignmentsPOST /v25-10-beta/agentic-logic/assignmentsPATCH /v25-10-beta/agentic-logic/assignments/{assignmentId}DELETE /v25-10-beta/agentic-logic/assignments/{assignmentId}GET /v25-10-beta/agentic-logic/sourcesPOST /v25-10-beta/agentic-logic/sources/validateGET /v25-10-beta/agentic-logic/sources/{name}PUT /v25-10-beta/agentic-logic/sources/{name}DELETE /v25-10-beta/agentic-logic/sources/{name}POST /v25-10-beta/agentic-logic/sources/{name}/refreshPOST /v25-10-beta/agentic-logic/evaluateGET /v25-10-beta/agentic-logic/exclusionsPATCH /v25-10-beta/agentic-logic/exclusions
Customer API keys select the organization. Agentic Logic must be enabled for that organization. Publish and run-gates requests return 202; poll the returned publishJobId for completion.
Last updated
Was this helpful?