Manage Experiment
manage_experimentPause, restart or reactivate one launched experiment. reactivate runs a Completed experiment again until end_date (required, YYYY-MM-DD). Restart and reactivate can increase spending: they first estimate the impact on budget groups and, when a group is affected, return a confirmation request without acting until confirm_budget_impact=true. Returns the platform operation result or an error. Keyword-level pause or restart is a separate operation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | The action to perform: 'pause' to stop the experiment, 'restart' to resume a paused one, 'reactivate' to run a completed one again until end_date | |
| end_date | No | Reactivate only, and required there: the new end date, YYYY-MM-DD, today or later (at most one year ahead on Facebook and Instagram). | |
| experiment_id | Yes | The experiment ID to pause, restart or reactivate (experimentId from search_experiments). | |
| confirm_budget_impact | No | Restart and reactivate only. Set true ONLY after the user explicitly confirmed the budget-group impact returned by a previous manage_experiment call with status='requires_confirmation'. | |
| auto_pause_ignore_historical_data | No | Restart only. When the experiment was auto-paused for low performance, true tells the optimizer to ignore the historical performance data that caused the pause. |