reportRoot: getTeamsTeamActivityDistributionCounts
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получите количество действий команды в Microsoft Teams за выбранный период.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Reports.Read.All | Недоступно. |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Для приложений | Reports.Read.All | Недоступно. |
Заметка: Чтобы разрешить приложениям считывать отчеты об использовании служб от имени пользователя, администратор клиента должен назначить пользователю соответствующую ограниченную роль администратора Microsoft Entra ID. Дополнительные сведения см. в разделе Авторизация api для чтения отчетов об использовании Microsoft 365.
HTTP-запрос
GET /reports/getTeamsTeamActivityDistributionCounts(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 (Дата обновления отчета);
- "Report Period" (Отчетный период).
- Активные пользователи
- Активные каналы
- Гости
- Реакции
- Организованные собрания
- Post Messages (Публикация сообщений);
- Сообщения канала
- Активные общие каналы
- Активные внешние пользователи
- Reply Messages (Ответные сообщения);
- Urgent Messages (Срочные сообщения);
- Упоминания
JSON
В случае успешного выполнения этот метод возвращает код отклика 200 OK
и объект JSON в тексте отклика.
Примеры
Пример 1. Выходные данные CSV
Ниже приведен пример вывода CSV-файла.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDistributionCounts(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,Report Period,Active Users,Active Channels,Guests,Reactions,Meetings Organized,Post Messages,Channel Messages,Active Shared Channels,Active External Users,Reply Messages,Urgent Messages,Mentions
Пример 2. Выходные данные JSON
Ниже приведен пример, возвращающий JSON.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDistributionCounts(period='D7')?$format=application/json
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 575
{
"@odata.context": "https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDistributionCounts(period='D7')?$format=application/json&$skiptoken=D07uj",
"value": [
{
"reportRefreshDate": "2021-09-01",
"userCounts": [
"reportPeriod":7,
"activeUsers": 26,
"activeChannels": 17,
"guests": 4,
"reactions": 36,
"meetingsOrganized": 0,
"postMessages": 83,
"channelMessages": 101,
"activeSharedChannels": 1,
"activeExternalUsers": 2,
"replyMessages":10,
"urgentMessages":8,
"mentions":1
]
}
]
}