Возвращается массив прошедших мероприятий со сводными данными по пользователям в этих мероприятиях.
МЕТОД HTTP
GET
URL
https://userapi.webinar.ru/v3/stats/events
ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ
- from — дата начала периода выборки.
Формат:yyy-mm-dd+hh:mm:ss
.
Без этого параметра запрос отработает от текущей даты и времени.
ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ
- to — дата окончания периода выборки.
Формат: yyy-mm-dd+hh:mm:ss.
По умолчанию: from + 1 год. - userId — ID сотрудника Организации. Ограничивает выборку вебинарами одного из сотрудников команды. ID можно получить запросом
GET /organization/members
. - Id — EventID вебинара. Позволяет получить данные о конкретном мероприятии.
Внимание! Вебинар должен проходить в рамкахfrom
иto
, иначе выборка будет пустой и в ответ придет404
.
ПОЛЯ ОТВЕТА
- id — eventsessionID вебинара;
- name — название вебинара;
- startsAt — время начала вебинара;
- endsAt — время окончания мероприятия;
- duration — длительность мероприятия. В секундах;
- invitedCount — количество приглашенных участников;
- invitedVisitedCount — количество приглашенных пользователей, которые посетили мероприятие;
- registeredCount — количество зарегистрированных участников. Включает в себя и зарегистрированных по приглашению, и зарегистрированных самостоятельно;
- registeredVisitedCount — количество посетивших участников;
- attendance — статистика по новым, постоянным, другим. Кто это такие по ссылке;
- country — распределение участников по странам и городам;
- platform — распределение участников по устройствам. Значения:
Web — смотрели через браузер;
Android — смотрели через мобильное приложение для Android;
iOS — смотрели через мобильное приложение для iOs;
- referrer — источники перехода. Для определения уникальности используются всевозможные части URL.
ПРИМЕР ЗАПРОСА
url: https://userapi.webinar.ru/v3/stats/events?from=2019-01-01+00:00:00&to=2019-12-30+00:00:00&userId={USER_ID}&eventId={EVENT_ID},
method: GET,
headers:
{
x-auth-token: {Token},
Content-Type: application/x-www-form-urlencoded
};
ПРИМЕР ОТВЕТА
200 - OK
[
{
"id": "2424413",
"name": "Миллионы тайн вселенной",
"startsAt": "2019-05-27T13:11:45+0300",
"endsAt": "2019-05-27T13:11:47+0300",
"duration": 2,
"invitedCount": 0,
"invitedVisitedCount": 0,
"registeredCount": 1,
"registeredVisitedCount": 1,
"attendance": {
"NEW": 0,
"REGULAR": 1,
"OTHER": 0
},
"country": {
"Russia": {
"countryCount": 1,
"Moscow": 1
}
},
"platform": {
"iOs": 0,
"Android": 0,
"Web": 1
},
"referrer": {
"https://events.webinar.ru/supportservice/2376543/stream-new/2424413": 1
}
}
]