reportRoot: getEmailAppUsageUserDetail

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Узнайте, какие действия пользователи выполняли в различных почтовых приложениях.

Заметка: Дополнительные сведения о различных представлениях и именах отчетов см. в статье Отчеты Microsoft 365 — использование приложений Email.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Reports.Read.All	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Для приложений	Reports.Read.All	Недоступно.

Примечание. Чтобы разрешить приложениям считывать отчеты об использовании служб от имени пользователя, администратор клиента должен назначить пользователю соответствующую Microsoft Entra ID ограниченную роль администратора. Дополнительные сведения см. в разделе Авторизация api для чтения отчетов об использовании Microsoft 365.

HTTP-запрос

GET /reports/getEmailAppUsageUserDetail(period='{period_value}')
GET /reports/getEmailAppUsageUserDetail(date={date_value})

Параметры функции

В URL-адресе запроса укажите один из приведенных ниже параметров и действительное значение.

Параметр	Тип	Описание
period	string	Указывает отчетный период. Поддерживаемые значения {period_value}: D7, D30, D90 и D180. Эти значения указываются в формате Dn, где n — количество дней в отчетном периоде.
date	Date	Указывает дату, за которую вы хотите просмотреть пользователей, выполнивших какое-либо действие. Значение {date_value} указывается в формате ГГГГ-ММ-ДД. Так как этот отчет доступен только за последние 30 дней, значение {date_value} должно быть датой из этого диапазона.

Примечание. В URL-адресе необходимо указать либо период, либо дату.

Этот метод поддерживает $formatпараметры запроса ,$topи $skipToken OData для настройки ответа. Тип выходных данных по умолчанию — text/csv. Однако если вы хотите указать тип выходных данных, можно использовать параметр запроса OData $format, для которого задано значение text/csv или application/json.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Отклик

CSV

В случае успешного выполнения этот метод возвращает отклик 302 Found, который перенаправляет на URL-адрес, для которого выполнена предварительная аутентификация, для скачивания отчета. Этот URL-адрес можно найти в заголовке Location отклика.

URL-адреса для скачивания, для которых выполнена предварительная аутентификация, действительны в течение нескольких минут и не требуют заголовка Authorization.

CSV-файл содержит столбцы со следующими заголовками:

• "Report Refresh Date" (Дата обновления отчета);
• "User Principal Name" (Имя участника-пользователя);
• "Display Name" (Отображаемое имя);
• "Is Deleted" (Удалено);
• "Deleted Date" (Дата удаления);
• "Last Activity Date" (Дата последнего действия);
• "Mail For Mac" (Почта для Mac);
• "Outlook For Mac" (Outlook для Mac);
• "Outlook For Windows" (Outlook для Windows);
• "Outlook For Mobile" (Outlook для мобильных устройств);
• "Other For Mobile" (Другое для мобильных устройств);
• "Outlook For Web" (Outlook для браузера);
• "POP3 App" (Приложение с поддержкой POP3);
• "IMAP4 App" (Приложение с поддержкой IMAP4);
• "SMTP App" (Приложение с поддержкой SMTP);
• "Report Period" (Отчетный период).

JSON

В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект JSON в тексте отклика.

Размер страницы по умолчанию для этого запроса — 200 элементов.

Пример

CSV

В следующем примере показан запрос, который выводит CSV-файл.

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/reports/getEmailAppUsageUserDetail(period='D7')?$format=text/csv

Отклик

Ниже показан пример отклика.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

У скачанного после перенаправления 302 CSV-файла будет приведенная ниже схема.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Last Activity Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period

JSON

В следующем примере показан запрос, возвращающий JSON.

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/reports/getEmailAppUsageUserDetail(period='D7')?$format=application/json

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 515

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "userPrincipalName": "userPrincipalName-value", 
      "displayName": "displayName-value", 
      "isDeleted": false, 
      "deletedDate": null, 
      "lastActivityDate": "2017-09-01", 
      "mailForMac": [ ], 
      "outlookForMac": [ ], 
      "outlookForWindows": [ ], 
      "outlookForMobile": [
        "Undetermined"
      ], 
      "otherForMobile": [ ], 
      "outlookForWeb": [
        "Undetermined"
      ], 
      "pop3App": [ ], 
      "imap4App": [ ], 
      "smtpApp": [ ], 
      "reportPeriod": "7"
    }
  ]
}