Краткая документация, собранная без лишнего шума.

Question types

Типы вопросов

Общие поля: id, type, title, description, required, timer, а также правила переходов и видимости.

Runtime

Прохождение анкеты

В тестовом режиме ?test=1 анкета работает как предпросмотр и не пишет ответы в базу. В боевом режиме создается сессия и каждый ответ сохраняется на сервере.

• POST /session/open открывает или возобновляет интервью по device_id.
• POST /session/answer сохраняет ответ после каждого шага.
• POST /sessions/<id>/end завершает интервью.
• Для booking бронь слота подтверждается только на шаге Далее, без предварительного hold; после выбора слота показывается обязательный номер телефона.

Подробно: /docs/runtime.md

Responses

Просмотр ответов

В активном проекте можно открыть список заполненных анкет и перейти внутрь конкретной сессии, чтобы листать вопросы и ответы в порядке анкеты.

• Вход доступен из таблицы активных проектов.
• Таблица Заполненные анкеты показывает сессии кроме in_progress.
• Для booking-проектов в admin UI есть отдельная вкладка загрузки слотов, етот режим показывает телефон и кнопку удаления записи.
• Фильтр по статусу собирается из реально загруженных данных.
• Если по выбранному статусу нет сессий, на экране остаётся пустая таблица.

Подробно: /docs/project_responses.md

Export

Экспорт данных

Результаты можно выгружать в CSV, XLSX и SPSS. Поддерживается фильтрация по статусам интервью и анонимизация IP и геоданных.

• Одиночный выбор экспортируется как одно поле, множественный - как бинарные столбцы по вариантам.
• Текст хранится строкой, шкала - числом, матрица - разложением по строкам и столбцам.
• Ranking и allocation кодируются в формате, пригодном для дальнейшего анализа.

Подробно: /docs/export.md

Piping

Подстановки

В тексты, заголовки и описания можно подставлять ответы на предыдущие вопросы, чтобы создавать более контекстный flow.

• @@QID - простой ответ.
• @@QID|N - N-й выбранный вариант или N-я ячейка матрицы.
• @@QID|#VAL - текст опции со значением VAL.
• @@QID|#ROW#COL - конкретное значение из матрицы.

Media

Загрузка и библиотека медиа

Для info_block и heatmap поддерживаются изображения и видео. В анкете лучше использовать относительные пути вроде /image/... и /video/....

• POST /__upload - загрузка для admin и superadmin.
• GET /media - библиотека медиа для организации.
• DELETE /media - удаление для административных ролей.

Подробно: /docs/media_library.md

Logic rules

routing_rules и visibility_rules

Раздел логики управляет переходами через routing_rules и видимостью через visibility_rules, используя JSON-выражения в if.

{
  "id": "rr1",
  "priority": 1,
  "if": { "==": ["$q1", "A"] },
  "goto": "q5"
}

{
  "id": "vr1",
  "priority": 1,
  "initial": "VISIBLE",
  "action": "HIDE",
  "if": { "==": ["$q1", "no"] }
}

Quickstart

Быстрый старт

Для локальной разработки backend обычно поднимается на 8000, frontend - на 3000. Во frontend API ходит через /api, чтобы dev и prod проксировались одинаково.

Для фонового локального запуска храните логи в output/logs/, а не в корне репозитория.

Подробно: /docs/quickstart.md

Settings

Настройки анкеты

• allow_back - разрешить возврат к предыдущим вопросам.
• allow_repeat - разрешить повторное прохождение.
• allow_resuming - продолжать опрос с того же места на том же устройстве.
• Для проектов с записью доступны отдельные вкладки сетки слотов и загрузки по слотам.
• Квоты, таймеры и служебные режимы тоже управляются из настроек проекта.

FAQ

Вопросы и ответы