Жизненный цикл - Console API

Управление состоянием эксперимента: запуск, остановка, архивация, разархивация. Все ручки возвращают {ok: true}.

Требуемый scope - edit:experiment:manage_experiment (см. Авторизацию).

к сведению

Интерактивный контракт с try-it-out - в Справочнике API (Swagger). Пошаговый сценарий интеграции - в сквозном сценарии.

Запуск

Эндпоинт	Что делает
POST /experiments/v1/{id}/start	Запускает эксперимент.

Остановка

Эндпоинт	Что делает
POST /experiments/v1/{id}/stop	Останавливает эксперимент. Причину передайте в теле ConsoleStopExperimentRequest.

Тело запроса ConsoleStopExperimentRequest описывает причину остановки. Оба поля опциональны.

Параметр	Тип	Обязательность	Пример	Описание
interruptReason	enum ExperimentInterruptReason | null	Нет	"bug"	Причина остановки.
interruptReasonComment	string | null	Нет	"регресс метрики"	Комментарий к причине.

ExperimentInterruptReason - справочник значений в Перечислениях.

Пример запроса остановки:

{
  "interruptReason": "critical_metric_impact",
  "interruptReasonComment": "падение конверсии в тестовой группе"
}

Архивация и разархивация

Эндпоинт	Что делает
POST /experiments/v1/{id}/archive	Переводит эксперимент в архив.
POST /experiments/v1/{id}/unarchive	Возвращает эксперимент из архива.

Ошибки действий

Для всех четырёх ручек действуют одинаковые правила ошибок:

Ситуация	Статус	Сообщение
Эксперимент не найден	404	Experiment with id=<id> was not found for action "<action>"
Действие недопустимо для статуса	400	Cannot perform action "<action>" for experiment id=<id>: current status is "<status>"

Сообщение статуса 400 включает текущий статус эксперимента и показывает причину отказа.