Получить статистику по организации
Возвращает агрегированную статистику использования продуктов Яндекс 360 по всей организации.
В отчете собраны общие данные за указанный период (от 1 дня до 3 месяцев). Данных за текущий день нет — они станут доступны только завтра.
Примечание
Чтобы выполнить запрос, приложению требуется разрешение на чтение статистики ya360_data:read_reports. Убедитесь, что вы включили его при настройке OAuth-приложения.
Запрос
GET https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/statistics
Path-параметры
|
Имя параметра |
Тип |
Описание |
|
org_id * |
string |
Идентификатор организации. |
Query-параметры
|
Имя параметра |
Тип |
Описание |
|
start_date * |
string |
Дата, с которой нужно получить данные. Формат: |
|
end_date * |
string |
Дата, по которую нужно получить данные. Формат: |
Заголовки
Authorization: OAuth <токен>
Пример
Пример запроса
curl -X GET -H "Authorization: OAuth <токен>" "https://cloud-api.yandex.net/v1/directory/organizations/123456/statistics?start_date=2023-01-01&end_date=2023-01-31"
Ответ
Успешный ответ
Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком записей статистики.
200 OK — запрос выполнен успешно.
|
Имя параметра |
Тип |
Описание |
|
data |
Список строк с данными по организации. |
v1OrgStatistics
|
Поле |
Тип |
Описание |
|
date |
string |
Дата, к которой относятся данные. |
|
users_count |
integer |
Общее количество сотрудников. |
|
administrators_count |
integer |
Количество администраторов. |
|
managers_count |
integer |
Количество менеджеров. |
|
active_users_count |
integer |
Количество активных сотрудников (минимум 1 действие за последние 30 дней). |
|
blocked_users_count |
integer |
Количество заблокированных сотрудников. |
|
domain_users_count |
integer |
Количество сотрудников с доменными аккаунтами. |
|
portal_users_count |
integer |
Количество сотрудников с портальными аккаунтами. |
|
guests_count |
integer |
Количество гостей. |
|
shared_contacts_count |
integer |
Количество внешних контактов. |
|
shared_mailboxes_count |
integer |
Количество общих ящиков. |
|
delegated_mailboxes_count |
integer |
Количество делегированных почтовых ящиков. |
|
meeting_rooms_count |
integer |
Количество переговорных комнат. |
|
mail_active_users_count |
integer |
Количество активных пользователей Почты (минимум 1 действие за последние 30 дней). |
|
mail_letters_count |
integer |
Общее количество писем. |
|
mail_sent_letters_count |
integer |
Количество отправленных писем. |
|
mail_received_letters_count |
integer |
Количество полученных писем. |
|
mail_replied_letters_count |
integer |
Количество писем с ответами. |
|
mail_read_letters_count |
integer |
Количество прочитанных писем. |
|
disk_active_users_count |
integer |
Количество активных пользователей Диска (минимум 1 действие за последние 30 дней). |
|
disk_shared_disks_count |
integer |
Количество общих дисков. |
|
disk_shared_disks_total_space_gb |
integer |
Объем памяти созданных общих дисков (в гигабайтах). |
|
disk_shared_disks_limit_gb |
integer |
Объем памяти оплаченных общих дисков (в гигабайтах). |
|
disk_uploaded_files_count |
integer |
Количество загруженных файлов на Диск. |
|
disk_file_views_count |
integer |
Количество просмотров файлов на Диске. |
|
disk_downloaded_files_count |
integer |
Количество скачиваний файлов с Диска. |
|
messenger_active_users_count |
integer |
Количество активных пользователей Мессенджера (минимум 1 действие за последние 30 дней). |
|
messenger_calls_count |
integer |
Количество звонков в Мессенджере. |
|
messenger_chats_created_count |
integer |
Количество созданных чатов. |
|
messenger_channels_created_count |
integer |
Количество созданных каналов. |
|
telemost_active_users_count |
integer |
Количество активных пользователей Телемоста (минимум 1 действие за последние 30 дней). |
|
telemost_conferences_count |
integer |
Количество встреч в Телемосте. |
|
telemost_conferences_created_count |
integer |
Количество созданных встреч в Телемосте. |
|
telemost_conferences_total_time_minutes |
integer |
Общее время встреч в Телемосте (в минутах). |
|
telemost_conferences_average_time_minutes |
integer |
Среднее время встречи в Телемосте (в минутах). |
|
telemost_conferences_average_participants |
integer |
Среднее количество участников встреч в Телемосте. |
|
telemost_conferences_up_to_2_participants_count |
integer |
Количество встреч до 2 участников. |
|
telemost_conferences_up_to_5_participants_count |
integer |
Количество встреч до 5 участников. |
|
telemost_conferences_up_to_10_participants_count |
integer |
Количество встреч до 10 участников. |
|
telemost_conferences_up_to_50_participants_count |
integer |
Количество встреч до 50 участников. |
|
telemost_conferences_over_50_participants_count |
integer |
Количество встреч с более чем 50 участниками. |
|
telemost_live_streams_created_count |
integer |
Количество созданных прямых трансляций в Телемосте. |
|
telemost_live_streams_count |
integer |
Количество прямых трансляций в Телемосте. |
|
telemost_live_streams_total_time_minutes |
integer |
Общее время прямых трансляций в Телемосте (в минутах). |
|
telemost_live_streams_average_time_minutes |
integer |
Среднее время прямой трансляции в Телемосте (в минутах). |
|
telemost_live_streams_average_participants |
integer |
Среднее количество зрителей прямых трансляций в Телемосте. |
Пример
Пример ответа
{
"data": [
{
"date": "2023-01-01",
"users_count": 100,
"administrators_count": 5,
"managers_count": 10,
"active_users_count": 90,
"blocked_users_count": 5,
"domain_users_count": 80,
"portal_users_count": 20,
"guests_count": 5,
"shared_contacts_count": 10,
"shared_mailboxes_count": 2,
"delegated_mailboxes_count": 3,
"meeting_rooms_count": 4,
"mail_active_users_count": 85,
"mail_letters_count": 5000,
"mail_sent_letters_count": 2500,
"mail_received_letters_count": 2500,
"mail_replied_letters_count": 1000,
"mail_read_letters_count": 2000,
"disk_active_users_count": 70,
"disk_shared_disks_count": 15,
"disk_shared_disks_total_space_gb": 1,
"disk_shared_disks_limit_gb": 10,
"disk_uploaded_files_count": 500,
"disk_file_views_count": 2000,
"disk_downloaded_files_count": 1500,
"messenger_active_users_count": 60,
"messenger_calls_count": 300,
"messenger_chats_created_count": 50,
"messenger_channels_created_count": 10,
"telemost_active_users_count": 40,
"telemost_conferences_count": 100,
"telemost_conferences_created_count": 80,
"telemost_conferences_total_time_minutes": 600,
"telemost_conferences_average_time_minutes": 60,
"telemost_conferences_average_participants": 5,
"telemost_conferences_up_to_2_participants_count": 20,
"telemost_conferences_up_to_5_participants_count": 50,
"telemost_conferences_up_to_10_participants_count": 20,
"telemost_conferences_up_to_50_participants_count": 8,
"telemost_conferences_over_50_participants_count": 2,
"telemost_live_streams_created_count": 5,
"telemost_live_streams_count": 5,
"telemost_live_streams_total_time_minutes": 300,
"telemost_live_streams_average_time_minutes": 60,
"telemost_live_streams_average_participants": 50
}
]
}
Неуспешный ответ
Ошибки могут быть со следующими HTTP-статусами:
400 Bad Request— параметры запроса не заданы или заданы неверно;401 Unauthorized— пользователь не авторизован;403 Forbidden— у пользователя или приложения нет прав на доступ к статистике;404 Not Found— запрашиваемая организация не найдена;500 Internal Server Error— ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).