Прохождения Линк Форм мероприятия

GET /userapi/eventsessions/{eventSessionId}/form-passings

Метод HTTP

GET


URL: 

https://userapi.mts-link.ru/v3/eventsessions/{eventSessionId}/form-passings

Описание

Метод выгружает Линк Формы мероприятия и ответы участников на них. Это формы, которые прикрепили к мероприятию или запустили в нём через меню «Инструменты», в том числе из группы форм. Ответ состоит из двух списков: forms — формы с их запусками и passings — прохождения этих форм с ответами, постранично.

Метод работает для любого мероприятия: вебинара, встречи, тренинга, мероприятия серии, урока курса и сессии автовебинара. Сертификат мероприятия на ответ не влияет. Ответы на форму сертификата для его выдачи выгружает метод «Выгрузка данных о прохождении форм» (https://help.mts-link.ru/article/30333).

Для метода нужен API-ключ с доступом к Линк Формам — тем же, что у методов аналитики форм.

Какие прохождения попадают в ответ:

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

Особенности:

  • пока мероприятие идёт, выгрузка не окончательная: прохождение появляется после подсчёта результатов и встаёт на место по времени завершения, в том числе на уже прочитанные страницы. Полную выгрузку делайте после окончания мероприятия;
  • тексты вопросов и вариантов — текущие: если форму изменили после мероприятия, в ответе новые тексты. Ответы на вопрос, удалённый из формы, не отдаются;
  • у анонимной формы (включено «Анонимное заполнение») ответы отдаются без данных участника: participantId, userId и name равны null;
  • в сессии автовебинара отдаются формы-инструменты автовебинара и прохождения, которые участники этой сессии начали от её старта до остановки. У сессии, которая ещё не стартовала, форм-инструментов в ответе нет;
  • даты — в формате ISO 8601 в часовом поясе мероприятия.

Если в мероприятии не прикрепляли и не запускали ни одной формы, метод вернёт 200 с пустыми forms и passings.

Обязательные параметры

  • eventSessionId — ID сессии мероприятия (передаётся в path).

Дополнительные параметры

  • formId — ID формы. Если передан, в ответе только эта форма и её прохождения. Если форма есть в организации, но в мероприятии её не прикрепляли и не запускали, вернутся пустые forms и passings.
  • page — номер страницы, начиная с 1. По умолчанию 1.
  • perPage — количество прохождений на странице: 10, 25, 50, 100, 250, 500 или 1000. По умолчанию 50.

Прохождения на странице идут по возрастанию времени завершения. Список forms отдаётся на каждой странице целиком. Страница за пределами данных вернёт 200 с пустым passings — это признак, что все прохождения получены.

Поля ответа

  • forms — Формы мероприятия, по времени первого запуска.
  • formId — ID формы.
  • formName — Текущее название формы.
  • launches — Запуски формы в мероприятии, по времени запуска.
  • formLinkId — ID запуска формы.
  • formUrl — Ссылка на прохождение формы.
  • launchedAt — Когда форму прикрепили или запустили. В сессии автовебинара — время первого показа инструмента, а если его не показывали — время старта сессии.
  • groupFormId — ID группы форм, из которой запущена форма; null — форму запустили вне группы.
  • passings — Прохождения на странице.
  • passingId — ID прохождения.
  • formId — ID формы.
  • formLinkId — ID запуска формы, по которому её прошли.
  • participantId — ID участника мероприятия; null — участие не найдено или форма анонимная.
  • userId — ID пользователя; null — форму прошли без учётной записи или форма анонимная.
  • name — Имя и фамилия участника, иначе имя в чате, у гостя — «Участник#<код>»; null — форма анонимная.
  • startedAt — Начало прохождения.
  • finishedAt — Завершение прохождения. Если форму остановил ведущий — время остановки.
  • finishType — Как завершилось прохождение: participant — участник отправил форму, timer — истёк таймер, author — ведущий остановил форму.
  • answers — Ответы участника в порядке вопросов формы. Вопросы без ответа не отдаются.
  • questionId — ID вопроса.
  • questionTitle — Текущий текст вопроса.
  • questionType — Тип вопроса: open — свободный ответ, choice — выбор, rank — сортировка, match — сопоставление, scale — шкала.
  • answer — Текст свободного ответа или значение шкалы (строкой); у других типов — null.
  • options — Выбранные варианты у выбора и сортировки (у сортировки — в порядке участника); у других типов — null.
  • optionId — ID варианта.
  • value — Текст варианта.
  • pairs — Пары у сопоставления; у других типов — null.
  • left — Левый элемент.
  • right — Правый элемент, который выбрал участник; null — пару не выбрали.
  • isCorrect — Верен ли ответ: true или false; null — вопрос не проверялся. Проверяются вопросы формы в режиме «Тест» с заданным правильным ответом, кроме шкалы и свободного ответа.

Коды ответа

  • 200 — Успешно.
  • 400 — Некорректные параметры: formId — не UUID, page — не положительное целое, perPage — не из списка.
  • 401 — Не передан заголовок X-Auth-Token.
  • 403 — Ключ не найден, неактивен или у него нет доступа к Линк Формам.
  • 404 — Мероприятия нет в организации ключа или оно удалено; формы formId нет или она другой организации и не связана с мероприятием.


Пример запроса

GET https://userapi.mts-link.ru/v3/eventsessions/123456/form-passings?perPage=100&page=1
X-Auth-Token: <your_api_key>


Пример ответа

200 — Успешно

{
  "data": {
    "forms": [
      {
        "formId": "1f0b3c2e-5a4d-6e7f-8a9b-0c1d2e3f4a5b",
        "formName": "Итоговый тест",
        "launches": [
          {
            "formLinkId": "1f0b3c2e-7b8c-6d9e-a0b1-c2d3e4f5a6b7",
            "formUrl": "https://<host>/forms/...",
            "launchedAt": "2026-11-10T12:20:00+03:00",
            "groupFormId": null
          }
        ]
      }
    ],
    "passings": [
      {
        "passingId": "1f0b3c2f-1a2b-6c3d-8e4f-5a6b7c8d9e0f",
        "formId": "1f0b3c2e-5a4d-6e7f-8a9b-0c1d2e3f4a5b",
        "formLinkId": "1f0b3c2e-7b8c-6d9e-a0b1-c2d3e4f5a6b7",
        "participantId": 456789,
        "userId": 1234567,
        "name": "Иван Иванов",
        "startedAt": "2026-11-10T12:21:05+03:00",
        "finishedAt": "2026-11-10T12:24:40+03:00",
        "finishType": "participant",
        "answers": [
          {
            "questionId": "1f0b3c2e-9c0d-6e1f-b2a3-c4d5e6f7a8b9",
            "questionTitle": "Какой язык используется для запросов к базе данных?",
            "questionType": "choice",
            "answer": null,
            "options": [
              { "optionId": "1f0b3c2e-aa11-6b22-8c33-d44e55f66a77", "value": "SQL" }
            ],
            "pairs": null,
            "isCorrect": true
          },
          {
            "questionId": "1f0b3c2e-bb22-6c33-9d44-e55f66a77b88",
            "questionTitle": "Сопоставьте термин и определение",
            "questionType": "match",
            "answer": null,
            "options": null,
            "pairs": [
              { "left": "Индекс", "right": "Ускоряет поиск строк" },
              { "left": "Транзакция", "right": null }
            ],
            "isCorrect": false
          },
          {
            "questionId": "1f0b3c2e-cc33-6d44-8e55-f66a77b88c99",
            "questionTitle": "Оцените курс от 1 до 10",
            "questionType": "scale",
            "answer": "9",
            "options": null,
            "pairs": null,
            "isCorrect": null
          },
          {
            "questionId": "1f0b3c2e-dd44-6e55-9f66-a77b88c99d00",
            "questionTitle": "Что добавить в курс?",
            "questionType": "open",
            "answer": "Больше практики",
            "options": null,
            "pairs": null,
            "isCorrect": null
          }
        ]
      }
    ]
  }
}


👆 На этом пока всё