Запросом можно получить статистику о посещении участниками мероприятий за указанный период.

МЕТОД HTTP

GET

URL

https://userapi.webinar.ru/v3/stats/users/visits

ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ

from — дата начала периода выборки. Формат: yyy-mm-dd+hh:mm:ss. Без этого параметра запрос отработает от текущей даты и времени.
email - Email участника, статистику которого необходимо получить (вместо email можно также использовать contactId - ID контакта участника).

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

to — дата окончания периода выборки.
Формат: yyy-mm-dd+hh:mm:ss.
По умолчанию: from + 1 год.
eventId — EventID мероприятия. Позволяет получить данные о конкретном мероприятии.
Внимание! Мероприятие должно проходить в рамках from и to, иначе выборка будет пустой и в ответ придет 404.

ПОЛЯ ОТВЕТА

registered — информация о мероприятиях, на которые зарегистрирован участник. Формат данных:
- id — ID eventsession мероприятия;
- name — название мероприятия;
- additionalFieldValues — данные регистрационных форм. Где:
- label — вопрос регистрационного поля;
- value — ответ участника;
- referrer — источник перехода на форму регистрации;
not_visited — информация о мероприятиях, которые участник не посетил, но на которые его пригласили. Формат данных:
- id — ID eventsession мероприятия;
- name — название мероприятия;
visited — информация о мероприятиях, которые участник посетил. Информация о каждом мероприятии передается в следующем формате:
- id — ID eventsession мероприятия;
- name — название мероприятия;
- referrer — источник перехода на форму регистрации;
- userQuestionCount — количество заданных вопросов;
- userChatMessageCount — количество написанных сообщений;
- actualParticipantActivityPercent — процент присутствия от активного времени ведущих;
- usersReactionClicks — количество нажатий на огонёк;
- percentOfTotalReactionClicks — процент нажатий на огонёк данного участника, от общего количество нажатий;
- actualInvolvement — фактическая активность (время, которое участник был на мероприятии и не переключался на другие вкладки, другие программы, не выключал звук у ведущих);
- attentionControl - данные модуля контроля присутствия. Для каждого из участников отображаются следующие данные:
- percent — процент подтверждённых окон, от общего количества.
- shownCount — общее количество окон подтверждения;
- confirmedCount — количество окон, подтверждённых участником;
- connections — информация о каждом подключении пользователя. Формат:
- joined — время подключения;
- leaved — время выхода;
- duration — продолжительность сессии;
- country — страна, из которой было подключение;
- city — город, из которого было подключение;
- referrer — источник перехода;
- platform — устройство, с которого было подключение.
- rating - рейтинг участника;
- utms — массив данных о полученных utm-метках. Передаются следующие данные, если они есть:
- utm_source
- utm_medium
- utm_campaign
- utm_content
- utm_term
- utm_custom - все прочие метки.

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

url: https://userapi.webinar.ru/v3/stats/users/visits?from=2019-05-17&email=i.ivanov@webinar.ru&eventId=2356719,
method: GET,
headers: 
{
    x-auth-token: {Token},
    Content-Type: application/x-www-form-urlencoded
};

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

200 － OK            
{
  "registered": [
    {
      "id": "2399983",
      "name": "User API",
      "referrer": "mail.google.com"
    }
  ],
  "not_visited": [],
  "visited": [
    {
      "id": "2399983",
      "name": "User API",
      "referrer": "mail.google.com",
      "userQuestionCount": 0,
      "userChatMessageCount": 9,
      "actualParticipantActivityPercent": 98.74,
      "usersReactionClicks": 0,
      "percentOfTotalReactionClicks": "0.00",
      "actualInvolvement": "32.77",
      "attentionControl": 9 {
          "shownCount": 6,
          "confirmedCount": 6,
          "percent": "100,00"
      }
      "connections": [
        {
          "joined": "2019-05-17T16:26:16+0300",
          "leaved": "2019-05-17T16:45:00+0300",
          "duration": 1124,
          "country": "Russia",
          "city": "Moscow",
          "referrer": "mail.google.com",
          "platform": "Web"

        }

                        ],
      "rating": 17,
      "utms": []
    },
               ]
}