A/B tests tools

list_discovery_experiments: List the A/B test experiments in an account.
get_discovery_experiment: Get the full configuration of a single experiment.
get_discovery_experiment_report: Get the analytics report for an experiment.

list_discovery_experiments

Lists the A/B test experiments in an account. The response gives you paginated summaries with each experiment's name, status, traffic allocation, buckets (variants), and scheduling details. Filter by status or name to narrow the list.

Use get_discovery_experiment for the full configuration of one experiment, and get_discovery_experiment_report for its statistical results.

Request parameters

Name	Type	Required?	Description
`account_name`	`str \| null`	No	The account name. If you have exactly one account, it's selected for you.
`site_group_id`	`str \| int \| null`	No	A site group ID or site name. Defaults to the account level (`-1`).
`page`	`int`	No	The page number, zero-based. Defaults to `0`.
`limit`	`int`	No	The number of results per page. Defaults to `10`.
`sort_by`	`str`	No	The field to sort by: `MODIFIED_AT`, `STARTED_AT`, `EXPERIMENT_NAME`, or `ID`. Defaults to `MODIFIED_AT`.
`sort_order`	`str`	No	The sort direction, `ASC` or `DESC`. Defaults to `DESC`.
`q`	`str \| null`	No	A search term, at least 3 characters, to filter by experiment or user name.
`experiment_statuses`	`str \| null`	No	A comma-separated list of statuses to filter by: `DRAFT`, `RUNNING`, `COMPLETED`, or `ARCHIVED`.

Response parameters

The tool returns an ExperimentsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[ExperimentSummary]`	The experiments in the account.
`error`	`str \| null`	Error message if the request failed.

The ExperimentSummary object has the following fields:

Field	Type	Description
`id`	`int`	The experiment's unique ID.
`experimentName`	`str \| null`	The experiment's display name.
`experimentType`	`str \| null`	The experiment type, `targeting` or `testing`.
`experimentStatus`	`str \| null`	The status: `DRAFT`, `RUNNING`, `COMPLETED`, or `ARCHIVED`.
`isEditable`	`bool \| null`	Whether the experiment can be edited.
`sitegroupId`	`int \| null`	The site group this experiment runs on.
`influence`	`str \| null`	The influence metric.
`trafficPercentage`	`int \| null`	The total percentage of traffic allocated to the experiment.
`startedAt`	`int \| null`	Unix timestamp in milliseconds of when the experiment started.
`endedAt`	`int \| null`	Unix timestamp in milliseconds of when the experiment ended.
`modifiedAt`	`int \| null`	Unix timestamp in milliseconds of the last modification.
`user`	`str \| null`	The user who last modified the experiment.
`isInternal`	`bool \| null`	Whether this is an internal experiment.
`note`	`str \| null`	An optional note.
`buckets`	`list[ExperimentBucket]`	The traffic buckets (variants) in the experiment.

The ExperimentBucket object has the following fields:

Field	Type	Description
`id`	`int \| null`	The bucket's ID.
`bucketName`	`str \| null`	The bucket's display name.
`trafficPercentage`	`int \| null`	The percentage of traffic routed to this bucket.
`bucketDescription`	`str \| null`	The bucket's description.
`control`	`bool \| null`	Whether this is the control bucket.
`ruleIdentifierInfo`	`ExperimentBucketRuleInfo \| null`	The rule info for the variant.

The ExperimentBucketRuleInfo object has the following fields:

Field	Type	Description
`id`	`int \| null`	The rule ID.
`ruleType`	`str \| null`	The rule type, such as `ranking` or `redirect`.
`variantId`	`int \| null`	The variant ID.
`modifiedAt`	`int \| null`	Unix timestamp in milliseconds of the last modification.
`user`	`str \| null`	The user who last modified the rule.
`query`	`list[ExperimentBucketQuery]`	The queries associated with this rule.

The ExperimentBucketQuery object has the following fields:

Field	Type	Description
`id`	`int \| null`	The query identifier.
`query`	`str \| null`	The query text.
`queryType`	`str \| null`	The query type, such as `sitesearch` or `category`.

get_discovery_experiment

Returns the full configuration of a single experiment, including its traffic allocation, buckets with rule info, success metric, and winner bucket if the experiment has completed. Use list_discovery_experiments first to find the experiment ID you want.

Request parameters

Name	Type	Required?	Description
`experiment_id`	`int`	Yes	The experiment ID returned by `list_discovery_experiments`.
`account_name`	`str \| null`	No	The account name. If you have exactly one account, it's selected for you.
`site_group_id`	`str \| int \| null`	No	A site group ID or site name. Defaults to the account level (`-1`).

Response parameters

The tool returns an ExperimentResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`ExperimentDetail \| null`	The full experiment record.
`error`	`str \| null`	Error message if the request failed.

The ExperimentDetail object adds the following fields on top of the summary record:

Field	Type	Description
`successMetric`	`str \| null`	The success metric: `AOV - Average Order Value`, `ATC Rate - Add to Cart Rate`, `CR - Conversion Rate`, or `RPV - Revenue Per Visit`.
`winnerBucketId`	`int \| null`	The ID of the winning bucket, set when the experiment completes.

get_discovery_experiment_report

Returns the analytics report for an experiment. The report shows performance metrics such as visitors, conversions, revenue, and statistical confidence, comparing the test buckets against a control bucket over a date range.

Every parameter is required. Use list_discovery_experiments or get_discovery_experiment first to obtain the bucket names and dates.

Request parameters

Name	Type	Required?	Description
`experiment_id`	`int`	Yes	The experiment ID.
`start_date`	`str`	Yes	The start date in `YYYYMMDD` format, for example `20240101`.
`end_date`	`str`	Yes	The end date in `YYYYMMDD` format, for example `20240131`.
`test_buckets`	`str`	Yes	A comma-separated list of test bucket names.
`control_bucket`	`str`	Yes	The control bucket name.
`experiment_session_type`	`str`	Yes	The session type: `SEARCH`, `CATEGORY`, or `GLOBAL`.
`experiment_name`	`str`	Yes	The experiment name. Must match exactly.

Response parameters

The tool returns an ExperimentReportResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`any \| null`	The report data, returned as freeform JSON from the analytics backend.
`error`	`str \| null`	Error message if the request failed.