Все коллекции
API и Webhooks
Статистика
Выгрузить статистику по участникам
Выгрузить статистику по участникам

GET stats/users

Обновлено больше недели назад

Возвращается массив данных о посещении мероприятий конкретными участниками.

Внимание! Если не указать from, то дата начала периода выборки будет равна текущей дате и времени и данные будут не валидны.

МЕТОД HTTP

GET

URL

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

  • from — дата начала периода выборки. Формат:  yyyy-mm-dd+hh:mm:ss.
    Без этого параметра запрос отработает от текущей даты и времени.

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

  • to — дата окончания периода выборки.  Формат: yyyy-mm-dd+hh:mm:ss. По умолчанию: from +1 год.

  • eventId EventID вебинара. Позволяет получить данные о конкретном мероприятии.
    Внимание! Вебинар должен проходить в рамках from и to, иначе выборка будет пустой и в ответ придет 404.

ПОЛЯ ОТВЕТА

  • id — UserID;

  • email — email;

  • name — имя;

  • secondName — фамилия;

  • pattrName — отчество;

  • sex — половая принадлежность. Значения:
     - m — мужчина;
     - f — женщина;
     - o — не указан;

  • phone — телефон;

  • organization — организация, в которой работает участник;

  • position — должность;

eventSessions — список вебинаров, которые посетил участник. Информация по вебинару:
- id — eventSessionsID в числовом формате;
- name - название;
- startsAt — время начала;
- endsAt — время окончания;
- duration — длительность мероприятия в секундах;

- eventId — eventID в числовом формате;
- questionCount — общее количество вопросов в вебинаре;
- userQuestionCount — количество вопросов, заданных участником;
- chatMessageCount — общее количество сообщений в чате вебинара;
- userChatMessageCount — количество сообщений в чате, написанное участником;
- additionalFieldValues — данные из регистрационной формы. Для каждого поля отображаются следующая информация:
         - label — название поля;
         - value — введенные участником данные;

- actualInvolvement - фактическая активность (время, которое участник был на мероприятии и не переключался на другие вкладки, другие программы, не выключал звук у ведущих);

- speechDuration — сколько в часах/минутах был активный звук от данного участника. Tсли он не был в эфире, то будет 00:00/
- percentOfTotalSpeechDuration — сколько времени говорил данный участник относительного общего наговоренного времени (не может быть больше 100%);

- usersReactionClicks - количество нажатий на огонёк;

- percentOfTotalReactionClicks - процент нажатий на огонёк данного участника, от общего количество нажатий;

- actualParticipantActivityPercent - процент присутствия от активного времени ведущих;

- rating - рейтинг участника;

- attentionControl - данные модуля контроля присутствия. Для каждого из участников отображаются следующие данные:
- percent — процент подтверждённых окон, от общего количества.
- shownCount — общее количество окон подтверждения;
- confirmedCount — количество окон, подтверждённых участником;
- connections — все подключения участника к мероприятию. Для каждого подключения отображается следующая информация:
         - joined — время входа;
         - leaved — время выхода;
         - duration — продолжительность присутствия в секундах;
         - country — страна, из который было подключение;
         - city — город, из которого было подключение;
         - referrer — источник перехода;
         - platform — устройство, с которого было подключение. Значения:
                  - Web — компьютер;
                  - iOs — приложение iOs;
                  - Android — приложение Android.
- utms — массив данных о полученных utm-метках. Передаются следующие данные, если они есть:
- utm_source

- utm_medium

- utm_campaign

- utm_content

- utm_term

- utm_custom - все прочие метки

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

url: https://userapi.webinar.ru/v3/stats/users?from=2019-04-01&to=2019-05-01&eventId=2308067,
method: GET,
headers:
{
    x-auth-token: {Token},
    Content-Type: application/x-www-form-urlencoded
};

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

200 - OK
[
  {
    "id": "5742",
    "email": "zuvov@mail.ru",
    "name": "Андрей",
    "secondName": "Зувов",
    "patrName": "",
    "phone": "+74959816222",
    "sex": "o",
    "eventSessions": [
      {
        "id": 2368927,
        "name": "Новое мероприятие сегодня",
        "startsAt": "2019-04-30T12:02:14+0300",
        "endsAt": "2019-04-30T13:35:52+0300",
        "duration": 5618,
        "eventId": "2308067",
        "questionCount": 0,
        "chatMessageCount": 2,
        "connections": [
          {
            "joined": "2019-06-21T13:28:51+0300",
            "leaved": "2019-04-30T12:02:47+0300",
            "duration": -4497964,
            "country": "Russia",
            "city": "Ulyanovsk",
            "platform": "Android"
          },
          {
            "joined": "2019-04-30T12:02:50+0300",
            "leaved": "2019-04-30T12:06:38+0300",
            "duration": 228,
            "country": "Russia",
            "city": "Ulyanovsk",
            "platform": "Android"
          }
        ],
        "userChatMessageCount": 0,
        "userQuestionCount": 0,
        "additionalFieldValues": [],
"actualInvolvement": "82.29",
"speechDuration": 0,
"percentOfTotalSpeechDuration": "0.00",
"usersReactionClicks": 0,
"percentOfTotalReactionClicks": "0.00",
"utms": ['utm_source' : { 'source' : 2, 'other_source': 3 }, 'utm_test2' : { 'test2' : 1, }, 'utm_test3' : { 'test3' : 1, }],
"actualParticipantActivityPercent": 86.97,
"rating": 82,
"attentionControl": {
"shownCount": 2,
"confirmedCount": 0,
"percent": 0
      }
  },
  {
    "id": "825893",
    "email": "m.finogeeva@webinar.ru",
    "name": "Мария",
    "secondName": "Финогеева",
    "patrName": "",
    "phone": "89771740189",
    "sex": "o",
    "organization": "ООО Вебинар Технологии",
    "position": "Руководитель группы Поддержки Вебинар",
    "eventSessions": [
      {
        "id": 2368927,
        "name": "Новое мероприятие сегодня",
        "startsAt": "2019-04-30T12:02:14+0300",
        "endsAt": "2019-04-30T13:35:52+0300",
        "duration": 5618,
        "eventId": "2308067",
        "questionCount": 0,
        "chatMessageCount": 2,
        "connections": [
          {
            "joined": "2019-04-30T12:32:14+0300",
            "leaved": "2019-04-30T12:35:38+0300",
            "duration": 204,
            "country": "Russia",
            "city": "Moscow",
            "platform": "iOs"
          }
        ],
        "userChatMessageCount": 1,
        "userQuestionCount": 0,
        "additionalFieldValues": []
"actualInvolvement": "26.42",
"speechDuration": 0,
"percentOfTotalSpeechDuration": "0.00",
"usersReactionClicks": 0,
"percentOfTotalReactionClicks": "0.00",
"utms": [],
"actualParticipantActivityPercent": 28.71,
"rating": 26,
"attentionControl": {
"shownCount": 2,
"confirmedCount": 2,
"percent": "100,00"
}
      }
    ]
  },
  {
    "id": "14531027",
    "email": "hjfjfhfh@mail.ru",
    "name": "вадим",
    "secondName": "hfhgfjhfhh",
    "eventSessions": [
      {
        "id": 2368927,
        "name": "Новое мероприятие сегодня",
        "startsAt": "2019-04-30T12:02:14+0300",
        "endsAt": "2019-04-30T13:35:52+0300",
        "duration": 5618,
        "eventId": "2308067",
        "questionCount": 0,
        "chatMessageCount": 2,
        "connections": [
          {
            "joined": "2019-04-30T12:03:19+0300",
            "leaved": "2019-04-30T12:04:23+0300",
            "duration": 64,
            "country": "Russia",
            "city": "St Petersburg",
            "platform": "Android"
          }
        ],
        "userChatMessageCount": 1,
        "userQuestionCount": 0,
        "additionalFieldValues": []
"actualInvolvement": "32.77",
"speechDuration": 0,
"percentOfTotalSpeechDuration": "0.00",
"usersReactionClicks": 0,
"percentOfTotalReactionClicks": "0.00",
"utms": [],
"actualParticipantActivityPercent": 98.74,
"rating": 37,
"attentionControl": {
"shownCount": 2,
"confirmedCount": 1,
"percent": "50,00"
}
      }
    ]
  }
]         


Нашли ответ на свой вопрос?