Skip to main content

List Experiments

GET 

/api/advertising/experiments

Returns a paginated list of holdout experiments, newest first by default, with the size of each arm (treatment_count, control_count).

Required scope: advertising:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Filters (all optional): filter[search] (ID exact, name partial; restrict with the top-level search_columns / search_strict_columns parameters). Numeric: id, control_share (a fraction, 0.1 = 10%). Text: name, status (draft, running, stopped, completed), treatment_type (guardrail_policy, goal, rule). Date: starts_on, ends_on (Y-m-d), created_at.

Filter operators. Text filters accept filter[<field>]=value (exact match) or filter[<field>.<operator>]=value with operators contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty. Numeric filters accept is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between (comma-separated pair), is_empty, is_not_empty. Date filters accept is, is_not, before, after, on_or_before, on_or_after, between (two comma-separated dates), is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days. Unknown filter names are rejected with 400 Bad Request.

filter_groups accepts a base64-encoded JSON filter tree for AND/OR combinations: {"conjunction": "and", "children": [{"type": "condition", "condition": {"column": "<field>.<operator>", "operator": "<operator>", "value": "..."}}, {"type": "group", "group": {"conjunction": "or", "children": [...]}}]}. When it is present it takes precedence over the flat filter[...] parameters.

Sorts: id, name, status, treatment_type, control_share, starts_on, ends_on, created_at; prefix with - for descending (default -id).

Pagination: per_page (default 10, max 100), page.

Requires the advertising.view permission.

Available only when the tenant has both the advertising and advertising-manager features enabled; otherwise every route here returns 404.

Request​

Responses​

OK

Response Headers
    Content-Type