Typeform
Формы, ответы и аналитика Typeform в процессах Pailot
Typeform — формы, опросы и квизы. Блок читает ответы, файлы и структуру формы через API (Application Programming Interface — программный интерфейс).
С Typeform в Pailot вы можете:
- Получать ответы с фильтром по дате и статусу завершения
- Скачивать файлы из полей загрузки
- Смотреть аналитику: отвалы по вопросам, конверсия по платформам
- Список форм, полная структура, создание, правка через JSON Patch и удаление
Нужен Personal Access Token Typeform. Процесс можно запускать в режиме триггера, когда приходит новая отправка: включите триггер и скопируйте URL вебхука (входящий HTTP-запрос). Не публикуйте URL.
Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Токен — в переменных окружения рабочего пространства.
Ответы по форме.
| Параметр | Тип | Обязательный | Описание |
|---|
formId | string | Да | ID формы Typeform |
apiKey | string | Да | Personal Access Token Typeform |
pageSize | number | Нет | Число ответов (по умолчанию 25) |
since | string | Нет | Ответы после этой даты (ISO 8601) |
until | string | Нет | Ответы до этой даты (ISO 8601) |
completed | string | Нет | Фильтр по завершению (true/false) |
| Параметр | Тип | Описание |
|---|
total_items | number | Всего ответов |
page_count | number | Число страниц |
items | array | Ответы: response_id, submitted_at, answers, метаданные |
Скачивание файла из ответа.
| Параметр | Тип | Обязательный | Описание |
|---|
formId | string | Да | ID формы Typeform |
responseId | string | Да | ID ответа с файлом |
fieldId | string | Да | ID поля загрузки файла |
filename | string | Да | Имя загруженного файла |
inline | boolean | Нет | Запросить файл с inline Content-Disposition |
apiKey | string | Да | Personal Access Token Typeform |
| Параметр | Тип | Описание |
|---|
fileUrl | string | Прямая ссылка на скачивание |
contentType | string | MIME-тип файла |
filename | string | Исходное имя файла |
Аналитика формы: отвалы, просмотры, конверсия.
| Параметр | Тип | Обязательный | Описание |
|---|
formId | string | Да | ID формы Typeform |
apiKey | string | Да | Personal Access Token Typeform |
| Параметр | Тип | Описание |
|---|
fields | array | Статистика по полям |
↳ dropoffs | number | Сколько человек ушло на этом поле |
↳ id | string | ID поля |
↳ label | string | Подпись поля |
↳ ref | string | Ссылочное имя поля |
↳ title | string | Заголовок или вопрос |
↳ type | string | Тип поля (например short_text, multiple_choice) |
↳ views | number | Сколько раз поле показали |
form | object | Сводка по форме и платформам |
↳ platforms | array | Метрики по платформам |
↳ average_time | number | Среднее время прохождения на платформе |
↳ completion_rate | number | Доля завершивших на платформе |
↳ platform | string | Платформа (например desktop, mobile) |
↳ responses_count | number | Число ответов с платформы |
↳ total_visits | number | Всего визитов с платформы |
↳ unique_visits | number | Уникальные визиты с платформы |
↳ average_time | number | Среднее время прохождения в целом |
↳ completion_rate | number | Общая доля завершивших |
↳ platform | string | Имя платформы (например desktop, mobile) |
↳ responses_count | number | Всего ответов |
↳ total_visits | number | Всего визитов |
↳ unique_visits | number | Всего уникальных визитов |
↳ summary | object | Общая сводка |
↳ average_time | number | Среднее время прохождения в целом |
↳ completion_rate | number | Общая доля завершивших |
↳ responses_count | number | Всего ответов |
↳ total_visits | number | Всего визитов |
↳ unique_visits | number | Всего уникальных визитов |
Список форм аккаунта.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Personal Access Token Typeform |
search | string | Нет | Поиск по названию формы |
page | number | Нет | Номер страницы (по умолчанию 1) |
pageSize | number | Нет | Форм на странице (по умолчанию 10, макс. 200) |
workspaceId | string | Нет | Фильтр по ID рабочего пространства |
| Параметр | Тип | Описание |
|---|
total_items | number | Всего форм в аккаунте |
page_count | number | Число страниц |
items | array | Формы: id, title, created_at, last_updated_at, settings, theme, _links |
Полная структура одной формы.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Personal Access Token Typeform |
formId | string | Да | Уникальный ID формы |
| Параметр | Тип | Описание |
|---|
id | string | Уникальный ID формы |
title | string | Название формы |
type | string | Тип (form, quiz и др.) |
settings | object | Настройки: язык, прогресс-бар и др. |
theme | object | Ссылка на тему |
workspace | object | Ссылка на рабочее пространство |
fields | array | Поля и вопросы |
welcome_screens | array | Экраны приветствия (пусто, если нет) |
thankyou_screens | array | Экраны благодарности |
created_at | string | Время создания (ISO 8601) |
last_updated_at | string | Время последнего обновления (ISO 8601) |
published_at | string | Время публикации (ISO 8601) |
_links | object | Связанные ссылки, включая публичный URL формы |
Создание формы с полями и настройками.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Personal Access Token Typeform |
title | string | Да | Название формы |
type | string | Нет | Тип (по умолчанию form). Варианты: form, quiz |
workspaceId | string | Нет | ID рабочего пространства |
fields | json | Нет | Массив полей. У каждого: type, title и опционально properties/validations |
settings | json | Нет | Настройки (language, progress_bar и др.) |
themeId | string | Нет | ID темы |
| Параметр | Тип | Описание |
|---|
id | string | ID созданной формы |
title | string | Название формы |
type | string | Тип формы |
settings | object | Настройки |
theme | object | Ссылка на тему |
workspace | object | Ссылка на рабочее пространство |
fields | array | Созданные поля (пусто, если не заданы) |
welcome_screens | array | Экраны приветствия (пусто, если нет) |
thankyou_screens | array | Экраны благодарности |
_links | object | Связанные ссылки, включая публичный URL формы |
Правка формы операциями JSON Patch.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Personal Access Token Typeform |
formId | string | Да | ID формы |
operations | json | Да | Массив операций JSON Patch (RFC 6902). У каждой: op (add/remove/replace), path и value (для add/replace) |
| Параметр | Тип | Описание |
|---|
message | string | Подтверждение успеха |
Безвозвратное удаление формы и всех ответов.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Personal Access Token Typeform |
formId | string | Да | ID формы |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Удалось ли удалить форму |
message | string | Подтверждение удаления |
