reportRoot: getOffice365GroupsActivityDetail

Статья
10/30/2023

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

Важно!

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

Сведения о действиях групп Microsoft 365 по группам.

Примечание: Дополнительные сведения о различных представлениях и именах отчетов см. в статье Отчеты Microsoft 365 — группы Microsoft 365.

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

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

Разрешения

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

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

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

HTTP-запрос

GET /reports/getOffice365GroupsActivityDetail(period='{period_value}')
GET /reports/getOffice365GroupsActivityDetail(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 (дата обновления отчета)
Group Display Name (отображаемое имя группы)
Is Deleted (удален)
Owner Principal Name (имя участника-владельца)
Last Activity Date (дата последнего действия)
Group Type (тип группы)
Member Count (количество участников)
External Member Count (количество внешних участников)
Exchange Received Email Count (количество полученных сообщений Exchange)
SharePoint Active File Count (количество активных файлов SharePoint)
Yammer Posted Message Count (количество опубликованных сообщений в Yammer)
Yammer Read Message Count (количество прочитанных сообщений в Yammer)
Yammer Liked Message Count (количество понравившихся сообщений в Yammer)
Количество сообщений канала Teams
Количество организованных собраний Teams
Exchange Mailbox Total Item Count (общее количество элементов в почтовых ящиках Exchange)
Exchange Mailbox Storage Used (Byte) [занято почтовыми ящиками Exchange (байт)]
SharePoint Total File Count (общее количество файлов SharePoint)
SharePoint Site Storage Used (Byte) [занято сайтами SharePoint (байт)]
Идентификатор группы
"Report Period" (Отчетный период).

Следующие столбцы не поддерживаются в Microsoft Graph для Китая, управляемом 21Vianet:

Yammer Posted Message Count (количество опубликованных сообщений в Yammer)
Yammer Read Message Count (количество прочитанных сообщений в Yammer)
Yammer Liked Message Count (количество понравившихся сообщений в Yammer)
Количество сообщений канала Teams
Количество организованных собраний Teams

JSON

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

Следующие свойства объекта office365GroupsActivityDetail не поддерживаются в Microsoft Graph для Китая под управлением 21Vianet:

yammerPostedMessageCount
yammerReadMessageCount
yammerLikedMessageCount
teamsChannelMessagesCount
teamsMeetingsOrganizedCount

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

Пример

CSV

Ниже приведен пример вывода CSV-файла.

Запрос

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

GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityDetail(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,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Member Count,External Member Count,Exchange Received Email Count,SharePoint Active File Count,Yammer Posted Message Count,Yammer Read Message Count,Yammer Liked Message Count,Teams Channel Messages Count,Teams Meetings Organized Count,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period

JSON

Ниже приведен пример, возвращающий JSON.

Запрос

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

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

Отклик

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365GroupsActivityDetail)", 
  "value": [
    {
      "groupId": "0003cf63-7ff3-4471-b24b-50ffbfb8b5d2",
      "reportRefreshDate": "2017-09-01", 
      "groupDisplayName": "groupDisplayName-value", 
      "isDeleted": false, 
      "ownerPrincipalName": "ownerDisplayName-value", 
      "lastActivityDate": "2017-08-31", 
      "groupType": "Private", 
      "memberCount": 5, 
      "externalMemberCount": 0, 
      "exchangeReceivedEmailCount": 341, 
      "sharePointActiveFileCount": 0, 
      "yammerPostedMessageCount": 0, 
      "yammerReadMessageCount": 0, 
      "yammerLikedMessageCount": 0, 
      "teamsChannelMessagesCount": 0,
      "teamsMeetingsOrganizedCount": 0,
      "exchangeMailboxTotalItemCount": 343, 
      "exchangeMailboxStorageUsedInBytes": 3724609, 
      "sharePointTotalFileCount": 0, 
      "sharePointSiteStorageUsedInBytes": 0, 
      "reportPeriod": "30"
    }
  ]
}

reportRoot: getOffice365GroupsActivityDetail

Разрешения

HTTP-запрос

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

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

Отклик

CSV

JSON

Пример

CSV

Запрос

Отклик

JSON

Запрос

Отклик

Обратная связь

Обратная связь

Дополнительные ресурсы