reportRoot: getTeamsTeamCounts

Пространство имен: 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/getTeamsTeamCounts(period='{period_value}')

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

В URL-адресе запроса укажите следующие параметры с допустимым значением.

Параметр	Тип	Описание
period	string	Указывает отчетный период. Для {period_value} поддерживаются следующие значения: D7, D30, D90, и D180. Эти значения соответствуют формату Dn, где n представляет количество дней, в течение которых отчет агрегирован. Обязательно.

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

Необязательные параметры запросов

Этот метод поддерживает $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 Date" (Дата отчета);
• Общедоступные команды
• Активные общедоступные команды
• Частные команды
• Активные частные команды

JSON

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

Примеры

Пример 1. Выходные данные CSV

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

Запрос

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

GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(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 Date,Public Teams,Active Public Teams,Private Teams,Active Private Teams,

Пример 2. Выходные данные JSON

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

Запрос

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

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

Отклик

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

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 641
{
  "@odata.context": "https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=application/json&$skiptoken=D07uj", 
  "value": [
    {
      "reportRefreshDate": "2021-09-01", 
      "reportPeriod":7,
      "teamsTeamUsageByDate": [
        {
          "reportDate": "2022-08-01", 
          "publicTeams": 26, 
          "privateTeams": 17, 
          "activePublicTeams": 20, 
          "activePrivateTeams": 12
        }
      ]
    }
  ]
}