sunsiyuan/human-survey

Задаёт вопросы и варианты ответов, которые показывает форма. Заменяет всю конфигурацию и сохраняет её как новую неизменяемую версию, поэтому уже собранные ответы продолжают описывать список, который им реально показывался. Повторная отправка идентичной конфигурации переиспользует существующую версию, а не создаёт ещё одну. Форма - это один вопрос с одиночным выбором, который при необходимости раскрывается во второй. Задайте варианту параметр expands, который называет другой вопрос, чтобы показать его при выборе этого варианта, именно так "TikTok" превращается в "which account". Идентификаторы вариантов должны быть стабильными ключами, которые переживают переименование. Использование хэндла в качестве идентификатора разделяет историю этого создателя на две части в тот день, когда он его изменит. Присвойте catalog_slug, чтобы взять метку и логотип варианта из каталога платформы. Порядок по умолчанию - "rotate", который рандомизируется для каждого респондента, и именно это делает сообщаемые доли несмещёнными; "fixed" сохраняет ваш порядок и принимает, что более ранние варианты выбираются чаще из-за того, что они раньше.

Создаёт форму и возвращает её id, URL для респондентов, а также iframe и слушатель postMessage для встраивания этого URL на страницу-хост. Форма пока не содержит вопросов и ничего не показывает респондентам, пока не будет настроена. allowed_origins ограничивает, какие сайты могут встраивать её; если оставить это поле пустым, встраивать сможет любой сайт, а значит, любой сайт сможет потратить квоту ответов этого аккаунта.

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

Перечисли платформы, которые знает HumanSurvey: slug для использования в качестве catalog_slug, отображаемое название и класс канала. Это именованные каналы, которые можно показать респонденту: TikTok, ChatGPT, LinkedIn, Reddit и так далее, плюс описательные варианты без бренда, например «мне рассказал друг или коллега». API-ключ не нужен.

Читает одну форму: ее настройки и конфигурацию вопросов, которая сейчас показывается респондентам, каждый вопрос, каждый вариант ответа и режим порядка. Возвращает конфигурацию в формате JSON, потому что это точно та структура, которую принимает запись конфигурации.

Перечисляет формы в этой учётной записи: id, имя, URL респондента, активна ли форма или приостановлена, настроена ли она уже с вопросами и сколько ответов она собрала.

Ответы, которые респонденты вводили вручную вместо выбора из списка, сгруппированные по точному тексту и упорядоченные по частоте ввода. Сообщает о замеченных вариантах написания, когда каждый был введён впервые и в последний раз, а также о том, покрывает ли его уже существующее сопоставление. Это дословные формулировки. Два похожих текста могут принадлежать разным людям, а текст может упоминать кого-то, кого вообще нет в списке кандидатов.

Входит с адресом электронной почты и сохраняет API-ключ на этой машине. При вызове только с адресом электронной почты отправляет на него шестизначный код и не возвращает ничего полезного: код должен поступить от человека, из его почтового ящика. При вызове с адресом и этим кодом сохраняет ключ в ~/.humansurvey/credentials и сообщает, куда он записан. Сам ключ никогда не выводится. Вход и регистрация - это одно и то же действие: адрес, который никогда не использовался, получает аккаунт.

Записываем, что конкретный введённый ответ означает конкретного кандидата. Это касается каждого ответа, который уже содержит этот текст, а также любого будущего ответа, поэтому числа, сообщённые для прошлых окон, меняются. Исходный текст никогда не изменяется, и сопоставление можно отменить, но отчёт уже может быть прочитан. Сопоставляйте только текст, значение которого установлено: текст, лишь похожий на имя кандидата, не доказательство того, что это он. Одно действующее сопоставление на каждый текст и на каждый вопрос.

Останавливает применение сопоставления. Введённые ответы, которые оно охватывало, возвращаются в список нерешённых, причём и в прошлых окнах, и в будущих, потому что сводки присоединяют сопоставления при чтении, а не при создании. Поэтому уже выведенные для этих окон числа изменятся. Ничего не удаляется: сопоставление помечается как отозванное и сохраняется, так что отчёт, созданный, пока оно действовало, всё ещё можно объяснить. Отзыв уже отозванного сопоставления не считается ошибкой и не сдвигает момент, когда оно перестало действовать. Идентификаторы сопоставлений появляются в списке свободного ввода рядом с любым уже сопоставленным текстом, а также в подтверждении, которое показывается при создании сопоставления.