ДОСТУПНО В BUSINESS ПОДПИСКЕ
Запрос: GET /report/active-users-by-period
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения и пользователь с ролью с индивидуальными настройками могут получат списки активных пользователей только тех подразделений, которыми управляют, и вложенных в них подразделений.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
| Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
| Параметр | Описание |
| activityDate[startDate] (необязательный) | Начало расчётного периода. Если не передавать параметр activityDate, берётся значение расчётного периода из подписки. |
| activityDate[endDate] (необязательный) | Конец расчётного периода. Если не передавать параметр activityDate, берётся значение расчётного периода из подписки. |
Параметры ответа
| Параметр | Описание |
|---|---|
| userId | ID пользователя |
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о пользователях в xml |
| 400 | Bad Request | Ошибка в запросе |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
GET /api/v3/report/active-users-by-period?activityDate[startDate]=2024-05-06&activityDate[endDate]=2024-05-06 HTTP/1.1 Host: learn-app.ispring.ru Authorization: cQ4Mlg_HMczFko6T99Q0yR2WharVQxfETml_GDwwT7Y
Пример ответа
<?xml version="1.0" encoding="UTF-8"?>
<response>
<ids>998415dc-2192-11ef-9b9c-0242ac130078</ids>
<activityStartDate>2023-05-06T10:50:00+00:00</activityStartDate>
<activityEndDate>2025-05-06T10:51:00+00:00</activityEndDate>
</response>