Получение статистики прохождения студентов конкретной группы.
В запросе указывается идентификатор курса {courseID} и идентификатор группы {groupID}. Эти идентификаторы можно получить запросом GET /organization/courses/groups.

МЕТОД HTTP

GET 

URL

https://userapi.webinar.ru/v3/courses/{courseID}/groups/{groupID}/statistics

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

Отсутствуют.

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

  • pagination[offset] — позволяет отобразить результат, начиная не с первого массива данных. Например в результате с 10 пользователями, если установить pagination[offset]=3, их отобразится 7, отбросив первых трёх. Параметр не может быть отрицательным. По умолчанию значение 0.
  • pagination[limit] — ограничивает количество выдаваемых пользователей в ответе. Параметр не может иметь отрицательное число, либо 0.
  • filter[lastActivityFrom] — задает нижнюю границу даты и времени активности студента. Формат: dd-mm-yyyy;
  • filter[lastActivityTo] — задает верхнюю границу даты и времени активности студента.Формат: dd-mm-yyyy. 

ПОЛЯ ОТВЕТА

Передается массив данных обо всех Студентах, зарегистрированных на это событие и соответствующее заданному фильтру. Формат передаваемых данных:

  • contact — информация о контакте (из адресной книги), сквозная в рамках аккаунта. Передается в виде массива данных:
    - id  — идентификатор контакта;
    - firstName —  имя контакта;
    - lastName — фамилия контакта;
  • student — информация о студенте (studentid). Уникальны в рамках каждой группы курса. Если один и тот же участник записался в 2 группы курса - это 2 разных studentid.
    Передается в виде массива данных:
    -  id — идентификатор студента;
    - status — текущий статус студента. Значения:
        - active — активный;
        - successed — успешно завершивший;
        - invited — приглашенный, но незарегистрированный;
        - registered — зарегистрированный, но не начавший проходить курс;
        - paid — оплативший, но не приступивших к обучению;
        - on_moderation — ожидающий модерацию администратором;
        - failed — проваливший;
    - registeredAt — дата регистрации студента на курс. Передается дата регистрации и часовой пояс, в котором эта дата отображена;
    - lastActivityAt — дата последней активности. Передается дата регистрации и часовой пояс, в котором эта дата отображена;
  • coursePassing — прогресс прохождения курса.
    Передаются значения полей:
    - status — статус в группе (все статусы описаны в запросе на получение группы);
    - passingProgress — процент прохождения уроков курса;
    - averageScore — набранный средний балл по всем заданиям с оценкой курса;
  • lessonsPassing — информация о прохождении уроков участником.
    Передается массив уроков. По каждому уроку пересылается следующая информация:
    - id — идентификатор урока;
    - name — название урока;
    - type — тип урока. Значения:
           - lesson — урок.Пост;
           - lessonTest — урок.Тест;
           - lessonWebinar — урок.Вебинар;
    - date —  дата и время прохождения с часовым поясом.
    Если участник не прошел урок то в поле будет значение null;
  • score — средний балл за тест. Только для уроков "Тест".

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

url: https://userapi.webinar.ru/v3/courses/{courseID}/groups/{groupID}//statistics?pagination[offset]=1& filter[lastActivityFrom]=17-09-2019
method: GET,
headers:
{
    x-auth-token: {Token},
    Content-Type: application/x-www-form-urlencoded
}

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

200 OK
[
    {
        "contact": {
            "id": 50890937,
            "firstName": "Мария",
            "lastName": "Финогеева",
            "email": "m.finogeevan@gmail.com"
        },
        "student": {
            "id": 412435,
            "status": "invited",
            "registeredAt": {
                "date": "2019-10-02 08:54:22.000000",
                "timezone_type": 3,
                "timezone": "Europe/Moscow"
            },
            "lastActivityAt": {
                "date": "2019-10-02 08:54:22.000000",
                "timezone_type": 3,
                "timezone": "Europe/Moscow"
            }
        },
        "coursePassing": {
            "status": "open",
            "passingProgress": 0,
            "averageScore": 0
        },
        "lessonsPassing": [
            {
                "id": 16615,
                "name": "Новый урок",
                "type": "lesson",
                "date": null
            },
            {
                "id": 16655,
                "name": "Сертификаты",
                "type": "lessonTest",
                "date": null,
                "score": 0
            },
            {
                "id": 54975,
                "name": "Урок.Вебинар",
                "type": "lessonWebinar",
                "date": null
            }
        ]
    }
]
Вы нашли ответ?