Выгрузить список участников мероприятия

GET /eventsessions/{eventsessionID}/participations

Запрос позволяет получить информацию об участниках, зарегистрированных на мероприятие с указанием факта посещения мероприятия.


Результаты выдаются не сразу все, а постранично. Номер отображаемой страницы и количество элементов на ней регулируются параметрами запроса.


МЕТОД HTTP

GET  


URL

https://userapi.mts-link.ru/v3/eventsessions/{eventsessionID}/participations


ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ

  • perPage — количество участников на одной странице. Значения:
    - 10
    - 50
    - 100
    - 250
    - 500
    Значение по умолчанию: 50;
  • page — номер страницы.
    Значение по умолчанию: 1.

ПОЛЯ ОТВЕТА

  • id — уникальный идентификатор участника в мероприятии (participationId); 
  • name — имя;
  • secondName — фамилия;
  • email — электронная почта;
  • isAccepted - статус одобрения участия на мероприятии. Значение:
    - 0 — участник находится на модерации;
    - 1 — участие одобрено.
  • role — роль в вебинаре. Подробнее о ролях;
  • userId — уникальный идентификатор пользователя на платформе (userid);
  • registerStatus — статус регистрации;
  • paymentStatus — статус оплаты;
  • url — токен участника, нужен для формирования уникальной ссылки на мероприятие;
  • additionalFieldValues — дополнительные поля из формы регистрации;
  • visited — статус посещения.
  • ip — IP-адрес, с которого участник последний раз подключался к мероприятию. Если участник не подключался или его IP неизвестен — `null`;
  • presenceDuration — время присутствия участника на мероприятии в секундах, целое число;
  • presencePercent — доля присутствия от длительности мероприятия в процентах, до двух знаков после запятой. Целое значение приходит без дробной части: `50`, а не `50.0`.

Примечание 

Поля ip, presenceDuration и presencePercentподключаются по запросу. Для подключения обратитесь к вашему персональному менеджеру или в службу технической поддержки. 

Как считается присутствие:

  • Учитываются все подключения участника к мероприятию. Если участник был подключён с нескольких устройств одновременно, это время считается один раз. Время до начала и после окончания мероприятия не учитывается.
  • Доля присутствия считается от длительности мероприятия — от фактического начала до фактического окончания. Она не превышает 100.

Для завершённого мероприятия значения совпадают с колонками вкладки «Участники» в XLS-файле статистики:

  • ip — «Последний IP»,
  • presenceDuration — «Присутствие относительно длительности мероприятия, чч:мм:сс»,
  • presencePercent — «Присутствие от общей длительности мероприятия».

Пока мероприятие идёт, значения предварительные:

  • время и доля считаются только по завершённым подключениям участника,
  • доля — от времени, прошедшего с начала мероприятия.
  • Если участник сейчас находится в комнате, время его текущего подключения не учитывается, а если он подключался с нескольких устройств одновременно, время складывается, и доля может превысить 100.
  • Точные значения появятся после завершения мероприятия.

До начала мероприятия presenceDuration и presencePercent равны 0, ip уже приходит, если участник ждёт начала в комнате.

Метод GET /events/{eventID}/participations эти поля не возвращает.


ПРИМЕР ЗАПРОСА

url: https://userapi.mts-link.ru/v3/eventsessions/{eventsessionID}/participations?page=1&perPage=50,
method: GET,
headers: 
{
    x-auth-token: {Token},
    Content-Type: application/x-www-form-urlencoded
};

  

ПРИМЕР ОТВЕТА

[ 
 { 
"id": 60387981,     
"name": "Специалист",     
"secondName": "тех.поддержки",     
"email": "support@webinar.ru",     
"avatar": {},     
"eventId": 2361791,     
"eventSessionId": 2405021,     
"isAccepted": 1,     
"role": "ADMIN",     
"isSeen": 1,     
"agreementStatus": "AGREED",     
"userId": 1029,     
"isOnline": "0",     
"registerStatus": "INVITED",     
"paymentStatus": "NOT_PAID",     
"url": "12fcd8413cf8b4b239f732b8481dc68f",     
"additionalFieldValues": [],     
"visited": true,     
"ip": "203.0.113.24",     
"presenceDuration": 1800,     
"presencePercent": 50   
 } 
] 
👆 На этом пока всё