Documentation
Documentation
Avenue Lift documentation
How to install Avenue Lift, measure conversions, build and review variants, read the results, and integrate through the JavaScript API, the REST API and webhooks.
Start with one tag
Everything begins with the snippet in your site's head. The quickstart takes you from there to a running experiment in four steps.
<script src="https://lift.example.com/s/lift_pk_YOUR_SITE_KEY"></script>Get started
- QuickstartFrom a new site to a running experiment: install the snippet, define a goal, create a variant and start.
- Installing the snippetWhere the script tag goes on plain HTML, Webflow, Shopify, WordPress, Squarespace, Wix, Framer, Google Tag Manager, strict-CSP sites and Next.js or React sites.
- Anti-flicker and performanceHow variants are applied before first paint, what the mask does, its hard timeout, and what the snippet costs a page.
Measure
Optimize
- Visual editorEdit a variant on your live page: what can be changed, how changes are stored and kept safe, and how editor sessions work.
- Experiments and the banditTargeting, assignment and traffic allocation, and how to read the results: probability of being best, expected loss and the sample-ratio check.
- Autopilot and AI reviewWhat the AI writes, how its variants are reviewed, and exactly what autopilot may do on its own.
- Preview and QA debug modeForce a variant with a link, inspect what the snippet is doing on a page, and switch it off for one page view.
Reference
- REST API referenceAuthentication, the response envelope, pagination, rate limits and every endpoint of the public API.
- WebhooksEvent types, the payload, signature verification, retries and what happens to a failing endpoint.
- JavaScript API referenceEvery method of the browser global, the pre-load queue, the query parameters and storage keys, and the server SDK.
Building an integration? The REST API is described in full by an OpenAPI 3.1 document at /api/public/v1/openapi.json.