Метод позволяет получить статистику по участнику обучения в рамках всех курсах организации.
Для получения статистики используется идентификатор пользователя — userId.
Получить идентификатор пользователя можно запросом GET /contacts/search или GET /contacts/1/user.

МЕТОД HTTP

GET 

URL

https://events.webinar.ru/api/userapi/organization/users/{userID}/statistics

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

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

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

  • pagination[offset] — позволяет отобразить результат, начиная не с первого массива данных. Например участник зарегистрирован на 10 курсов, если установить pagination[offset]=3, курсов отобразится 7, отбросив первые три из них. Параметр не может быть отрицательным. По умолчанию значение 0;
  • pagination[limit] — ограничивает количество выдаваемых курсов в результате. Параметр не может иметь отрицательное число, либо 0.

ПОЛЯ ОТВЕТА

  • group — массив данных о группах, в которой состоит Студент;
  • 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://events.webinar.ru/api/userapi/organization/users/{users}/statistics,
method: GET,
headers:
{
    x-auth-token: {Token}
  },
};  

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

200 OK
[
  {
    "group": {
      "id": 1,
      "startsAt": {
        "date": "2019-04-15 22:39:19.000000",
        "timezone_type": 3,
        "timezone": "Europe/Moscow"
      },
      "endsAt": null,
      "course": {
        "id": 1,
        "name": "Новый курс"
      }
    },
    "contact": {
      "id": 2,
      "firstName": "test",
      "lastName": "user 02",
      "email": "test02@mailforspam.com"
    },
    "student": {
      "id": 2,
      "status": "active",
      "lastActivityAt": {
        "date": "2019-04-16 01:30:37.000000",
        "timezone_type": 3,
        "timezone": "Europe/Moscow"
      }
    },
    "coursePassing": {
      "status": "open",
      "passingProgress": 33,
      "averageScore": 0
    },
    "lessonsPassing": [
      {
        "id": 1,
        "name": "Новый урок",
        "type": "lesson",
        "date": null
      },
      {
        "id": 2,
        "name": "Новый тест abc",
        "type": "lessonTest",
        "date": null,
        "score": 0
      },
      {
        "id": 3,
        "name": "Новый урок",
        "type": "lesson",
        "date": null
      }
    ]
  }
]
Вы нашли ответ?