Справочники - Console API

Справочники возвращают допустимые значения для полей эксперимента, а перечисления (enum) фиксируют наборы значений в схемах запросов и ответов. При создании и обновлении эксперимента имена полей (команда, тип участника, метрики) должны строго совпадать со значениями из справочников.

к сведению

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

Справочники для формы

Одиннадцать GET-справочников возвращают данные для заполнения формы эксперимента. Все они требуют scope read:experiment:read_experiments.

Схемы ответов каждого справочника - в Справочнике API (Swagger).

Эндпоинт	Что возвращает
GET /experiments/v1/dictionaries/types	Типы экспериментов.
GET /experiments/v1/dictionaries/domains	Продуктовые домены.
GET /experiments/v1/dictionaries/participantTypes	Типы участников.
GET /experiments/v1/dictionaries/layers	Слои.
GET /experiments/v1/dictionaries/holdouts	Холдауты.
GET /experiments/v1/dictionaries/participant-lists	Списки участников (allowed / excluded).
GET /experiments/v1/dictionaries/context-param-predicates	Параметры сегментов и операторы.
GET /experiments/v1/dictionaries/teams	Оргструктура команд.
GET /experiments/v1/dictionaries/objective-meta	Метрики и срезы для цели.
GET /experiments/v1/dictionaries/preset-names	Имена пресетов метрик.
GET /experiments/v1/dictionaries/tags	Теги.

к сведению

Справочник participantTypes использует camelCase в пути, остальные ручки - kebab-case.

Справочник context-param-predicates

Ручка context-param-predicates принимает тело ConsoleExperimentContextPredicatesRequest со следующими полями:

Параметр	Тип	Обязательность	Пример	Описание
experimentId	int | null	Нет	12345	ID эксперимента.
domainId	int | null	Нет	7	ID домена.

Ответ содержит список параметров params (объекты ConsoleContextParamDTO), доступные операторы predicates и их применимость predicateApplicability. Каждый параметр несёт поля id, type, title, label, status (enum ContextParamStatus) и domainId.

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

Справочники меняются редко. Кэшируйте ответы на стороне интеграции и сбрасывайте кэш при ошибках валидации 400.

Перечисления (enum)

Console API использует перечисления в схемах запросов и ответов. Ниже - значения каждого перечисления и их смысл.

ExperimentType

Тип эксперимента - поле type.

Значение	Описание
regular	Классический A/B-эксперимент.
retro	Ретроанализ - расчёт по историческим данным.
switchback	Switchback-эксперимент - чередование групп во времени.
dfp	Эксперимент с влиянием на внешнюю рекламу (DFP-слой).
dfp_filler	Служебный эксперимент-заполнитель для DFP-слоя.
holdout_analyzer	Технический эксперимент для анализа holdout-группы.
crm	Эксперимент на CRM-коммуникациях - exposure наступает при отправке сообщения пользователю.
adhoc	Устаревший тип. В новых экспериментах не используйте.

ExperimentMarkupScopeType

Тип разметки пользователей - поле markupScopeType.

Значение	Описание
incoming_traffic	Разметка всего входящего трафика.
event	Разметка по событию. Аудиторию фильтруют segments.
segment	Разметка списками участников на группах control и test.

ConsoleExposureType

Режим учёта exposure - поле exposure.

Значение	Описание
all	Exposure учитывается без ограничения по дням.
days	Exposure распространяется на заданное число дней (propagateExposureDays).

StatisticsMethod

Статистический метод анализа - поле statisticalMethod.

Значение	Описание
frequentist	Частотный метод анализа.
bayesian	Байесовский метод анализа.

RetroType

Тип ретроанализа - поле retro.type.

Значение	Описание
parent_experiment	Ретро на основе существующего A/B-эксперимента. Требует parentExperimentId.
lists	Ретро на основе списков участников.
participant_source	Ретро на основе источника участников.

SwitchbackStrategy

Стратегия распределения кластеров - поле switchback.strategy.

Значение	Описание
DETERMINISTIC_RANDOM	Детерминированное случайное распределение. Единственная доступная стратегия.

ExperimentInterruptReason

Причина остановки эксперимента - поле interruptReason метода stop.

Значение	Описание
sequential_testing_significant_change	Значимое изменение по результатам последовательного тестирования.
critical_metric_impact	Критичное влияние на метрики.
bug	Остановка из-за ошибки.
other	Другая причина.

ContextParamStatus

Статус контекст-параметра - поле status в ответе справочника context-param-predicates.

Значение	Описание
draft	Черновик. Параметр нельзя использовать в фильтрах сегментов, изменения разрешены.
active	Параметр доступен для фильтрации, изменения запрещены.
archived	В новых фильтрах использовать нельзя, созданные ранее фильтры продолжают работать.
deleted	Параметр удалён. Недоступен ни в новых, ни в существующих фильтрах.