reportRoot: getOffice365GroupsActivityCounts
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Узнайте, сколько различных действий было в группах.
Заметка: Дополнительные сведения о различных представлениях и именах отчетов см. в статье Отчеты 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/getOffice365GroupsActivityCounts(period='{period_value}')
Параметры функции
В URL-адресе запроса укажите приведенный ниже параметр и действительное значение.
| Параметр | Тип | Описание |
|---|---|---|
| period | string | Указывает отчетный период. Поддерживаемые значения {period_value}: D7, D30, D90 и D180. Эти значения указываются в формате Dn, где n — количество дней в отчетном периоде. Обязательный. |
Этот метод поддерживает $formatпараметр запроса OData для настройки ответа. Тип выходных данных по умолчанию — text/csv. Однако если вы хотите указать тип выходных данных, можно использовать параметр запроса OData $format, для которого задано значение text/csv или application/json.
Заголовки запросов
| Имя | Описание |
|---|---|
| Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Отклик
CSV
В случае успешного выполнения этот метод возвращает отклик 302 Found, который перенаправляет на URL-адрес, для которого выполнена предварительная аутентификация, для скачивания отчета. Этот URL-адрес можно найти в заголовке Location отклика.
URL-адреса загрузки с предварительной проверкой подлинности действительны только в течение короткого периода времени (несколько минут) и не требуют заголовка Authorization .
CSV-файл содержит столбцы со следующими заголовками:
- Report Refresh Date (дата обновления отчета)
- Exchange Emails Received (получено писем Exchange)
- Yammer Messages Posted (опубликовано сообщений в Yammer)
- Yammer Messages Read (прочитано сообщений в Yammer)
- Yammer Messages Liked (понравилось сообщений в Yammer)
- Сообщения канала Teams
- Организованные собрания Teams
- Report Date (дата отчета)
- "Report Period" (Отчетный период).
Следующие столбцы не поддерживаются в Microsoft Graph для Китая, управляемом 21Vianet:
- Yammer Messages Posted (опубликовано сообщений в Yammer)
- Yammer Messages Read (прочитано сообщений в Yammer)
- Yammer Messages Liked (понравилось сообщений в Yammer)
- Сообщения канала Teams
- Организованные собрания Teams
JSON
В случае успешного 200 OK выполнения этот метод возвращает код ответа и объект office365GroupsActivityCounts в тексте ответа.
Следующие свойства объекта office365GroupsActivityCounts не поддерживаются в Microsoft Graph для Китая под управлением 21Vianet:
- yammerMessagesPosted
- yammerMessagesRead
- yammerMessagesLiked
- teamsChannelMessages
- teamsMeetingsOrganized
Пример
CSV
Ниже приведен пример вывода CSV-файла.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityCounts(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,Exchange Emails Received,Yammer Messages Posted,Yammer Messages Read,Yammer Messages Liked,Teams Channel Messages,Teams Meetings Organized,Report Date,Report Period
JSON
Ниже приведен пример, возвращающий JSON.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityCounts(period='D7')?$format=application/json
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 310
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365GroupsActivityCounts)",
"value": [
{
"reportRefreshDate": "2017-09-01",
"exchangeEmailsReceived": 0,
"yammerMessagesPosted": 0,
"yammerMessagesRead": 0,
"yammerMessagesLiked": 0,
"teamsChannelMessages": 0,
"teamsMeetingsOrganized": 0,
"reportDate": "2017-09-01",
"reportPeriod": "7"
}
]
}