# Apex by Drip documentation

Official documentation for installing, configuring, operating, and integrating Apex by Drip.

## Getting started
- [What is Apex?](https://docs.drip-apex.com/docs/getting-started/what-is-apex): A plain-language overview of Apex, the core A/B testing concepts, and how the storefront SDK, Worker, and dashboard fit together.
- [Glossary](https://docs.drip-apex.com/docs/getting-started/glossary): Plain-language definitions for common Apex terms such as experiments, variations, goals, assignments, guardrails, SDK, Worker, and consent mode.
- [Launchpad](https://docs.drip-apex.com/docs/getting-started/launchpad): The daily command center for a shop. It shows readiness, active tests, draft blockers, recent learning, and the next best action.
- [Access, authentication, and workspace selection](https://docs.drip-apex.com/docs/getting-started/access-authentication-workspace-selection): Controls who can enter Apex, which workspace they operate in, and which shop becomes active for every dashboard and API action.
- [How Apex detects your store](https://docs.drip-apex.com/docs/getting-started/store-scan): What the onboarding store scan reads, how platform detection works, and what the detected storefront tools mean.
- [Install Apex on Shopify](https://docs.drip-apex.com/docs/getting-started/shopify): Connect the Apex Shopify app, enable the storefront app embed, and understand what Shopify data Apex receives.
- [Install Apex on WooCommerce](https://docs.drip-apex.com/docs/getting-started/woocommerce): Connect the Apex WooCommerce plugin with an install token, upload the plugin zip, and understand what WooCommerce data Apex receives.
- [Verify your Shopify tracking](https://docs.drip-apex.com/docs/getting-started/shopify-verify): Confirm the Shopify app connection, storefront app embed, and first Apex telemetry signal during onboarding.
- [Install Apex on Shopware](https://docs.drip-apex.com/docs/getting-started/shopware): Install the private Apex Shopware app package, confirm registration, and understand what Shopware data Apex receives.
- [Install Apex on a custom storefront](https://docs.drip-apex.com/docs/getting-started/custom-js): Add the Apex script snippet to a custom, Webflow, headless, or other non-native storefront.
- [Coexistence with other testing tools](https://docs.drip-apex.com/docs/getting-started/coexistence-with-other-testing-tools): Move page areas to Apex safely while existing experimentation and analytics tools remain installed.
- [Install Apex on a headless React storefront](https://docs.drip-apex.com/docs/getting-started/headless-react): Add Apex to a Next.js or Hydrogen storefront, render experiment branches with React hooks, and preserve Shopify cart attribution.
- [Install Apex on a headless Nuxt storefront](https://docs.drip-apex.com/docs/getting-started/headless-nuxt): Add Apex to a Nuxt 3 Shopify storefront, configure OneTrust consent, handle SPA navigation, and preserve cart attribution.

## Experiments
- [Experiment creation and lifecycle](https://docs.drip-apex.com/docs/experiments/overview): The core A/B testing workflow: create a draft, configure targeting and metrics, build variants, QA, launch, monitor, pause, complete, archive, or restore.
- [Ideas and backlog](https://docs.drip-apex.com/docs/experiments/ideas-backlog): The planning layer for experiment concepts before they become tests. It stores hypotheses, evidence, source context, comments, priority, and handoff notes.
- [Variant builder, visual mutations, and code mode](https://docs.drip-apex.com/docs/experiments/builder-visual-code): The builder authors the actual storefront change for a variation. It supports visual mutations, custom CSS/JS, file-based code workspaces, previews, revisions, and generated changes.
- [Migrating a test from Kameleoon](https://docs.drip-apex.com/docs/experiments/migrating-from-kameleoon): Move a Kameleoon JavaScript and CSS test into Apex, preview it safely, and finish its targeting, goals, and QA.
- [Template tests on Shopify](https://docs.drip-apex.com/docs/experiments/template-tests-shopify): Test Shopify alternate templates with a same-page redirect and the view query parameter.
- [Apex Operator and tool-led building](https://docs.drip-apex.com/docs/experiments/apex-operator): Apex Operator is the model-led experiment builder. It gives the model compact tools for inspecting pages, network traffic, state, selectors, artifacts, QA evidence, and persistence.
- [Edit a draft on the live store](https://docs.drip-apex.com/docs/experiments/on-site-editor): Use the on-site editor to inspect, change, and save a draft against the merchant's real page while keeping Quick preview as the zero-install fallback.
- [QA workspace, previews, screenshots, and launch gating](https://docs.drip-apex.com/docs/experiments/qa-and-previews): QA proves that a variant renders correctly, tracking fires, screenshots are captured, and launch blockers are resolved before visitors see a test.
- [Targeting, pages, audiences, and segments](https://docs.drip-apex.com/docs/experiments/targeting-audiences): Defines who and what page qualifies for experiments, feature flags, and personalization rules.
- [Metrics, goals, and conversion tracking](https://docs.drip-apex.com/docs/experiments/metrics-goals): Creates reusable success events for experiments: click, pageview, custom, revenue, and Shopify-connected conversion goals.
- [Metric definitions](https://docs.drip-apex.com/docs/experiments/metric-definitions): Defines the populations, counting rules, and quality checks behind experiment results, so raw events can be reconciled with reported numbers.
- [Results, imported outcomes, and readback](https://docs.drip-apex.com/docs/experiments/results): Turns live and completed experiment data into decisions, learnings, and future backlog evidence.
- [Guardrails, planned tests, and auto-pause](https://docs.drip-apex.com/docs/experiments/guardrails-auto-pause): Defines the statistical and operational rules that determine when tests can launch, pause, and be interpreted.
- [Checkout-block experiments](https://docs.drip-apex.com/docs/experiments/checkout-blocks): Checkout block tests are paused while Apex builds a new version.
- [Feature flags](https://docs.drip-apex.com/docs/experiments/feature-flags): Runtime toggles for off/on variants, typed payloads, rollout percentages, targeting, and source-experiment promotion.
- [Personalization](https://docs.drip-apex.com/docs/experiments/personalization): Signal-driven storefront experiences with ordered rules, payloads, targeting, rollout controls, and decision debugging.

## Analytics
- [Analytics suite](https://docs.drip-apex.com/docs/analytics/overview): Store-wide and experiment-aware reporting across visitors, conversions, revenue, ecommerce, traffic, funnels, journey flow, realtime events, and measurement quality.
- [Dashboard and realtime analytics](https://docs.drip-apex.com/docs/analytics/dashboard-realtime): Existing analytics surfaces for overview reporting and realtime install debugging.
- [Heatmaps, behavior screenshots, and visual evidence](https://docs.drip-apex.com/docs/analytics/heatmaps-evidence): Adds visual and behavioral proof to analytics so teams can understand not only whether a test moved a metric but how visitors interacted.
- [Funnels and ecommerce analytics](https://docs.drip-apex.com/docs/analytics/funnels-ecommerce): Existing funnel and ecommerce analytics surfaces for page detection, path analysis, revenue, and reconciliation.
- [Profit analysis and Shopify reconciliation](https://docs.drip-apex.com/docs/analytics/profit-reconciliation): Adds product cost, inventory, order, and contribution-margin context so experiment results can be read against profit, not only conversion rate.
- [Store profile, audits, signals, and learning runs](https://docs.drip-apex.com/docs/analytics/store-profile-signals): The persistent memory of a shop: brand facts, technical findings, product-data depth, storefront evidence, customer signals, audit findings, and operator learnings.

## Statistics
- [Statistics](https://docs.drip-apex.com/docs/statistics): How Apex measures experiments, protects decisions, and verifies its statistical guarantees with deterministic simulation.
- [How Apex statistics work](https://docs.drip-apex.com/docs/statistics/methodology-and-certification): The business logic, statistical safeguards, and three-million-experiment certification behind Apex decisions.
- [Audit of Bayesian stopping rules](https://docs.drip-apex.com/docs/statistics/bayesian-stopping-audit): Deterministic A/A simulations of common chance-to-beat and expected-loss decision rules under daily peeking.
- [Audit of bandit campaign-mode allocation](https://docs.drip-apex.com/docs/statistics/bandit-campaign-audit): 1.15 million simulated merchant campaigns measuring what adaptive traffic allocation earns, and what it does to the reported result.

## Landing pages
- [Landing pages and landing-page QA](https://docs.drip-apex.com/docs/landing-pages/overview): Keeps the versions, previews, QA evidence, publish state, and experiments of landing pages that are built outside Apex and deployed with the CLI.
- [Build landing pages with your own tools](https://docs.drip-apex.com/docs/landing-pages/build-and-deploy): Build a landing page in a folder with Claude Code, Codex or any static-site build, then apply, preview, deploy, roll back and test it with Apex.

## Settings and account
- [Store connection, Shopify install, and Web Pixel](https://docs.drip-apex.com/docs/settings-account/installation): Connects Apex to a storefront so experiments, analytics, Shopify events, product data, and revenue analysis can work.
- [Runtime controls, SDK, anti-flicker, and consent](https://docs.drip-apex.com/docs/settings-account/runtime-sdk-controls): The browser runtime fetches experiment config, assigns visitors, applies variants, tracks goals, respects runtime settings, and batches events.
- [Edge routing and custom domains](https://docs.drip-apex.com/docs/settings-account/edge-routing-domains): Routes customer domains through the Apex Worker path for edge-managed experiences and SSL-for-SaaS style storefront handling.
- [API keys and public API v1](https://docs.drip-apex.com/docs/settings-account/api-keys): Lets external systems create and manage experiments, variations, goals, screenshots, webhooks, privacy requests, and harness sessions.
- [Team, clients, organization, account, and admin settings](https://docs.drip-apex.com/docs/settings-account/team-organization): Manages who can access work, which clients belong to an agency, account-level preferences, integrations, and organization-level configuration.
- [Privacy, export, deletion, and auditability](https://docs.drip-apex.com/docs/settings-account/privacy-data): Supports compliance workflows for exporting or deleting visitor/user data and auditing sensitive operational actions.
- [Assets and references](https://docs.drip-apex.com/docs/settings-account/assets-references): Stores images, PDFs, creative references, and prompt material used for experiments, landing pages, and Operator instructions.
- [Allowlist Apex in your firewall](https://docs.drip-apex.com/docs/settings-account/firewall-allowlisting): Let Apex previews pass your storefront WAF without weakening other protections.

## Data and privacy
- [GDPR export and deletion](https://docs.drip-apex.com/docs/data-privacy/gdpr-export-deletion): Use Apex privacy endpoints to export or delete visitor data for a shop-scoped privacy request.
- [Consent integration for privacy teams](https://docs.drip-apex.com/docs/data-privacy/consent-integration): Plain-language guidance for how Apex renders tests before consent while blocking persistent identity and tracking until permission is available.
- [Consent and regional compliance](https://docs.drip-apex.com/docs/data-privacy/consent-regional-compliance): Configure Apex so storefront testing and tracking respect consent requirements, Do Not Track, and regional privacy expectations.
- [Developer access and data](https://docs.drip-apex.com/docs/data-privacy/developer-access-data): A public overview of the Apex data stores, developer access paths, and safety rules for technical teams integrating with Apex.

## Developers
- [Developer overview](https://docs.drip-apex.com/docs/developers/overview): Developer-oriented Apex documentation for SDK runtime behavior, API keys, public API v1, webhooks, privacy exports, and generated references.
- [Public API surface map](https://docs.drip-apex.com/docs/developers/api/overview): Routes in the Apex public API v1 contract, grouped by host and authentication.
- [Webhook payload reference](https://docs.drip-apex.com/docs/developers/webhooks): Configure Apex webhooks, verify signatures, and handle the event payloads Apex delivers today.
- [Public event schema](https://docs.drip-apex.com/docs/developers/event-schema): The Apex analytics event wire format accepted by the Worker and written to Tinybird.
- [Worker public endpoints](https://docs.drip-apex.com/docs/developers/worker-endpoints): Public Apex Worker routes for event ingest, snippets, runtime config, landing pages, previews, and health checks.
- [Shopify Pixel integration](https://docs.drip-apex.com/docs/developers/shopify-pixel): How the Apex Shopify Web Pixel maps Shopify customer events, dedupes event IDs, and buffers attribution.
- [External checkout pixels](https://docs.drip-apex.com/docs/developers/external-checkout-pixels): Attribute purchases from third-party checkout or booking platforms with Apex handover and a confirmation-page pixel.
- [SDK examples](https://docs.drip-apex.com/docs/developers/sdk): A thin pointer to the full Apex SDK reference for install, runtime API, React bindings, and InitConfig.
- [Price basis for value-bearing treatments](https://docs.drip-apex.com/docs/developers/price-basis-value-treatments): Choose and document the price source for treatments built against staging and production storefronts.

## API reference
- [Generated OpenAPI reference](https://docs.drip-apex.com/docs/api/reference): Generated endpoint reference built from the local Apex OpenAPI spec.

## CLI reference
- [Install and authenticate the Apex CLI](https://docs.drip-apex.com/docs/cli/install-auth): Install apex, sign in with the default browser OAuth flow, and use API-key fallbacks for headless environments.
- [CLI commands, JSON, and exit codes](https://docs.drip-apex.com/docs/cli/commands-output): Every registered Apex CLI command, the stable JSON envelope, exit-code meanings, and headless agent usage rules.
- [Experiment lifecycle commands](https://docs.drip-apex.com/docs/cli/experiments-lifecycle): Create, list, inspect, read results, pause, complete, and delete Apex experiments from the CLI.
- [Experiment filesystem and QA commands](https://docs.drip-apex.com/docs/cli/experiments-filesystem-qa): Pull experiment files, plan and apply safe changes, and record QA evidence from the Apex CLI.
- [Workspace, Operator, and roadmap commands](https://docs.drip-apex.com/docs/cli/workspace-operator-roadmap): Check out draft variation workspaces, run live previews, publish workspace files, and pull approved roadmap handoffs.
- [Push and GitOps with `.drip.config.ts`](https://docs.drip-apex.com/docs/cli/push-gitops): Use apex push to sync local experiment definitions to Apex with slug-based idempotent upserts.
- [Tracking, goals, targeting, preview, and harness](https://docs.drip-apex.com/docs/cli/tracking-goals-targeting-preview-harness): Generate tracking manifests, manage goals, test targeting, open QA previews, and publish AB Test Harness artifacts.
- [Agent tools: SOS, brand, schema, and skills](https://docs.drip-apex.com/docs/cli/agent-tools-sos-brand-schema-skills): Use Apex CLI agent-oriented commands for brand context, SOS handoffs, command schema introspection, and local skill installation.

## Reference
- [Complete feature catalog](https://docs.drip-apex.com/docs/reference/feature-catalog): Route-level map of Apex app surfaces from the original docs catalog.
- [Data model](https://docs.drip-apex.com/docs/reference/data-model): Apex relational model families and enum groups from the original docs data model map.
- [Help, docs, brand surfaces, and generated references](https://docs.drip-apex.com/docs/reference/help-docs-brand-generated-references): The support layer for understanding Apex, finding help, sharing brand context, and inspecting machine-readable API documentation.

## MCP server
- [Install and configure the Apex MCP server](https://docs.drip-apex.com/docs/mcp/install-configure): Connect ChatGPT, Codex, Claude Desktop, Claude Code, or Cursor to Apex experiments with the Drip MCP server.
- [Apex MCP tool reference](https://docs.drip-apex.com/docs/mcp/tool-reference): Reference for the tools exposed by the Apex MCP server.

## SDK reference
- [Install and quickstart the Apex SDK](https://docs.drip-apex.com/docs/sdk/install-quickstart): Choose the hosted script snippet or npm package, initialize Apex, and send your first SDK events.
- [`init()` and InitConfig reference](https://docs.drip-apex.com/docs/sdk/init-config): Reference every supported Apex SDK InitConfig field with its type, default, and intended use.
- [SSR framework coexistence](https://docs.drip-apex.com/docs/sdk/framework-coexistence): Integrate Apex with hydrating Nuxt and Next.js storefronts using mutation re-assertion, hydration timing, and explicit lifecycle hooks.
- [Consent modes](https://docs.drip-apex.com/docs/sdk/consent-modes): Configure Apex SDK consent gating with custom consent, OneTrust, Usercentrics, Cookiebot, CCM19, Shopify Customer Privacy, Pandectes, or CookieScript.
- [SPA and router modes](https://docs.drip-apex.com/docs/sdk/spa-router): Configure Apex SDK route observation, DOM re-evaluation, and manual activation for dynamic storefronts.
- [Anti-flicker modes](https://docs.drip-apex.com/docs/sdk/anti-flicker): Use scoped, full-page, custom, or disabled anti-flicker behavior in the Apex SDK.
- [Runtime API](https://docs.drip-apex.com/docs/sdk/runtime-api): Reference the Apex SDK runtime functions for initialization, tracking, consent, flags, diagnostics, and assignment state.
- [Code-owned definitions and `.drip.config.ts`](https://docs.drip-apex.com/docs/sdk/config-definitions): Define experiments and feature flags in TypeScript, then pair them with Apex CLI GitOps push.
- [React bindings](https://docs.drip-apex.com/docs/sdk/react-bindings): Use DripProvider and all Apex SDK React hooks for assignments, variations, flags, tracking, revenue, cart metafields, and loading state.
- [Vue and Nuxt bindings](https://docs.drip-apex.com/docs/sdk/vue-bindings): Reactive Apex assignments, feature flags, tracking, and server-rendered Nuxt variants.
- [Feature flags in code](https://docs.drip-apex.com/docs/sdk/feature-flags): Define, evaluate, and read typed Apex feature flag values from the SDK.
- [Migration notes](https://docs.drip-apex.com/docs/sdk/migration-notes): Move removed Apex SDK init aliases to the current InitConfig fields.

## App SDK
- [App SDK overview and install](https://docs.drip-apex.com/docs/app-sdk/overview): Run Apex flags and tests in hybrid apps built with Ionic, Angular, Capacitor or Cordova. Install the npm package and configure it with a publishable key.
- [Angular setup](https://docs.drip-apex.com/docs/app-sdk/angular-setup): Configure the App SDK in an Angular or Ionic app with an app initializer, a root service, optional NGXS state, an RxJS helper and Capacitor Preferences storage.
- [Flags and typed values](https://docs.drip-apex.com/docs/app-sdk/flags-typed-values): Read boolean, string, number and JSON object flag values in a hybrid app, validate typed objects, and control when Apex records an exposure.
- [Goals and purchases](https://docs.drip-apex.com/docs/app-sdk/goals-purchases): Track goal events and order revenue from a hybrid app. Send each purchase once per order with a stable order ID, and understand how Apex attributes revenue to tests.
- [Users and identity](https://docs.drip-apex.com/docs/app-sdk/users-identity): Identify signed-in users in a hybrid app, wait for their assignments before reading flags, and return to the anonymous device identity on logout.
- [Test your build](https://docs.drip-apex.com/docs/app-sdk/testing-your-build): Mark test-build traffic as QA, pin a test phone or test account to a variation with QA devices, and check a device's events with the device lookup.
- [App lifecycle and offline behaviour](https://docs.drip-apex.com/docs/app-sdk/lifecycle-offline): How the App SDK queues events offline, sends them when the app goes to the background, refreshes assignments in the foreground, and handles sessions.
- [Troubleshooting](https://docs.drip-apex.com/docs/app-sdk/troubleshooting): Turn on App SDK diagnostics with a logger, read each log line, and fix common setup problems such as a blocked events host or an invalid publishable key.
- [Supported versions](https://docs.drip-apex.com/docs/app-sdk/supported-versions): Angular, Ionic, Capacitor, Cordova, TypeScript and Node versions tested with the App SDK, plus build requirements for current iOS and Xcode.