Skip to main content
Experiments enable A/B testing of paywalls, offerings, and remote configurations. Each experiment has one or more groups (variants), and users are attached to a specific group either automatically by audience rules or manually via the API.

​
Key concepts

  • Status — draft, running, paused, or stopped.
  • Groups — Variants within an experiment. Each group carries a payload (offering, screen, remote config value, etc.).
  • User attachment — POST /v4/experiments/{experiment_id}/users/{user_id} pins a user to a group.
  • Summary — /v4/experiments/summary returns aggregated performance metrics across experiments.

​
Available endpoints

MethodEndpointDescriptionStatus
GET/experimentsList experimentsNew
POST/experimentsCreate an experimentNew
GET/experiments/summaryGet experiments analytics summaryNew
DELETE/experiments/{experiment_id}Delete an experimentNew
GET/experiments/{experiment_id}Get an experimentNew
PATCH/experiments/{experiment_id}Partially update an experimentNew
GET/experiments/{experiment_id}/groupsList experiment groupsNew
POST/experiments/{experiment_id}/groupsCreate an experiment groupNew
DELETE/experiments/{experiment_id}/groups/{group_id}Delete an experiment groupNew
PATCH/experiments/{experiment_id}/groups/{group_id}Update an experiment groupNew
POST/experiments/{experiment_id}/statusChange experiment statusNew
DELETE/experiments/{experiment_id}/users/{user_id}Detach a user from an experimentNew
POST/experiments/{experiment_id}/users/{user_id}Attach a user to an experiment groupNew

​
Authentication

All v4 endpoints require a Secret Key. See Authentication.