Получить статистику по пользователям

Возвращает статистику использования продуктов Яндекс 360 пользователями организации.

В отчете собраны данные за указанный период (от 1 дня до 3 месяцев). Данных за текущий день нет — они станут доступны только завтра.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на чтение статистики ya360_data:read_reports. Убедитесь, что вы включили его при настройке OAuth-приложения.

Запрос

GET https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/users/statistics

Path-параметры

Имя параметра	Тип	Описание
org_id *	string	Идентификатор организации.

Query-параметры

Имя параметра	Тип	Описание
start_date *	string	Дата, с которой нужно получить данные. Формат: `YYYY-MM-DD`.
end_date *	string	Дата, по которую нужно получить данные. Формат: `YYYY-MM-DD`.
limit	integer	Максимальное количество записей в ответе.
iteration_key	string	Ключ для получения следующей порции данных.

Заголовки

Authorization: OAuth <токен>

Пример

Пример запроса

curl -X GET -H "Authorization: OAuth <токен>" "https://cloud-api.yandex.net/v1/directory/organizations/123456/users/statistics?start_date=2023-01-01&end_date=2023-01-31"

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON.

200 OK — запрос выполнен успешно.

Имя параметра	Тип	Описание
items	v1UserStatistics[]	Список строк с данными по пользователям организации.
iteration_key	string	Ключ для получения следующей порции данных.

v1UserStatistics

Поле	Тип	Описание
date	string	Дата, к которой относятся данные.
user_id	string	UID пользователя.
nickname	string	Nickname пользователя.
account_type	string	Тип аккаунта (`domain`/`portal`/`other`).
name	string	Имя пользователя.
is_admin	boolean	Является ли пользователь администратором.
is_manager	boolean	Является ли пользователь менеджером.
is_enabled	boolean	Является ли пользователь активным (минимум 1 действие за последние 30 дней).
mail_last_usage_date	string	Дата последнего использования Почты.
mail_sent_letters_count	integer	Количество отправленных писем.
mail_received_letters_count	integer	Количество полученных писем.
mail_read_letters_count	integer	Количество прочитанных писем.
mail_replied_letters_count	integer	Количество писем с ответами.
disk_last_usage_date	string	Дата последнего использования Диска.
disk_uploaded_files_count	integer	Количество загруженных файлов на Диск.
disk_file_views_count	integer	Количество просмотров файлов на Диске.
disk_downloaded_files_count	integer	Количество скачиваний файлов с Диска.
messenger_last_usage_date	string	Дата последнего использования Мессенджера.
messenger_calls_count	integer	Количество звонков в Мессенджере.
messenger_chats_created_count	integer	Количество созданных чатов.
messenger_channels_created_count	integer	Количество созданных каналов.
telemost_last_usage_date	string	Дата последнего использования Телемоста.
telemost_conferences_count	integer	Количество встреч в Телемосте.
telemost_conferences_created_count	integer	Количество созданных встреч в Телемосте.
telemost_conferences_total_time_minutes	integer	Общее время встреч в Телемосте (в минутах).
telemost_live_streams_created_count	integer	Количество созданных прямых трансляций в Телемосте.
telemost_live_streams_count	integer	Количество прямых трансляций в Телемосте.
telemost_conferences_average_time_minutes	integer	Среднее время встреч в Телемосте (в минутах).

Пример

Пример ответа

{
  "items": [
    {
      "date": "2023-01-01",
      "user_id": "123456",
      "nickname": "ivan.ivanov",
      "account_type": "domain",
      "name": "Иван Иванов",
      "is_admin": false,
      "is_manager": true,
      "is_enabled": true,
      "mail_last_usage_date": "2023-01-31",
      "mail_sent_letters_count": 100,
      "mail_received_letters_count": 200,
      "mail_read_letters_count": 180,
      "mail_replied_letters_count": 50,
      "disk_last_usage_date": "2023-01-30",
      "disk_uploaded_files_count": 10,
      "disk_file_views_count": 50,
      "disk_downloaded_files_count": 20,
      "messenger_last_usage_date": "2023-01-31",
      "messenger_calls_count": 5,
      "messenger_chats_created_count": 2,
      "messenger_channels_created_count": 1,
      "telemost_last_usage_date": "2023-01-29",
      "telemost_conferences_count": 10,
      "telemost_conferences_created_count": 5,
      "telemost_conferences_total_time_minutes": 60,
      "telemost_live_streams_created_count": 0,
      "telemost_live_streams_count": 0,
      "telemost_conferences_average_time_minutes": 5
    }
  ],
  "iteration_key": "next_page_key_123"
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на доступ к статистике;
404 Not Found — запрашиваемая организация не найдена;
500 Internal Server Error — ошибка произошла на стороне сервера.

Была ли статья полезна?

Статистика по организации (CSV)

Статистика по пользователям (CSV)