reportRoot: getTeamsUserActivityUserDetail

Статья
07/04/2024

Пространство имен: 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/getTeamsUserActivityUserDetail(period='{period_value}')
GET /reports/getTeamsUserActivityUserDetail(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 (Дата обновления отчета);
Tenant Display Name (Отображаемое имя клиента);
Shared Channel Tenant Display Names (Отображаемые имена клиентов общего канала);
Идентификатор пользователя
"User Principal Name" (Имя участника-пользователя);
Last Activity Date (Дата последнего действия);
Is Deleted (Удален);
Deleted Date (Дата удаления);
Assigned Products (Назначенные продукты);
Team Chat Messages Count (Количество сообщений в чатах групп);
Private Chat Message Count (Количество сообщений в приватных чатах);
Call Count (Количество звонков);
Meeting Count (Количество собраний);
Post Messages (Публикация сообщений);
Reply Messages (Ответные сообщения);
Urgent Messages (Срочные сообщения);
Meetings Organized Count (Количество организованных собраний);
Meetings Attended Count (Количество посещенных собраний);
Ad Hoc Meetings Organized Count (Количество организованных незапланированных собраний);
Ad Hoc Meetings Attended Count (Количество посещенных незапланированных собраний);
Scheduled One-time Meetings Organized Count (Количество организованных запланированных разовых собраний);
Scheduled One-time Meetings Attended Count (Количество посещенных запланированных разовых собраний);
Scheduled Recurring Meetings Organized Count (Количество организованных запланированных повторяющихся собраний);
Scheduled Recurring Meetings Attended Count (Количество посещенных запланированных повторяющихся собраний);
Audio Duration (Длительность аудио);
Video Duration (Длительность видео);
Screen Share Duration (Длительность демонстрации экрана);
Audio Duration In Seconds (Длительность аудио в секундах);
Video Duration In Seconds (Длительность видео в секундах);
Screen Share Duration In Seconds (Длительность демонстрации экрана в секундах);
Has Other Action (Есть другое действие);
Is Licensed (Наличие лицензии);
"Report Period" (Отчетный период).

Примечание.

Значения в счетчике организованных совещаний могут не совпадать с суммой счетчика организованных разовых собраний, счетчика организованных запланированных разовых собраний и счетчика запланированных повторяющихся собраний, организованных пользователем в течение указанного периода времени. Это связано с тем, что значение "Несекретные собрания" не включается в выходной CSV-файл. Подробнее см. в отчете об активности пользователей Microsoft Teams.

JSON

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

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

Примеры

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

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

Запрос

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

GET https://graph.microsoft.com/beta/reports/getTeamsUserActivityUserDetail(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,Tenant Display Name,Shared Channel Tenant Display Names,User Id,User Principal Name,Last Activity Date,Is Deleted,Deleted Date,Assigned Products,Team Chat Message Count,Private Chat Message Count,Call Count,Meeting Count,Post Messages,Reply Messages,Urgent Messages,Meetings Organized Count,Meetings Attended Count,Ad Hoc Meetings Organized Count,Ad Hoc Meetings Attended Count,Scheduled One-time Meetings Organized Count,Scheduled One-time Meetings Attended Count,Scheduled Recurring Meetings Organized Count,Scheduled Recurring Meetings Attended Count,Audio Duration,Video Duration,Screen Share Duration,Audio Duration In Seconds,Video Duration In Seconds,Screen Share Duration In Seconds,Has Other Action,Is Licensed,Report Period

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

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

Запрос

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

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

Отклик

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

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

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

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "tenantDisplayName": "Microsoft",
      "sharedChannelTenantDisplayNames": "SampleTenant",
      "userId": "userId-value", 
      "userPrincipalName": "userPrincipalName-value", 
      "isLicensed": true, 
      "lastActivityDate": "2017-09-01", 
      "isDeleted": false, 
      "deletedDate": null, 
      "assignedProducts": [
        "Microsoft 365 ENTERPRISE E5"
      ], 
      "teamChatMessageCount": 0, 
      "privateChatMessageCount": 49, 
      "callCount": 2, 
      "meetingCount": 0,
      "postMessages": 10,
      "replyMessages": 1,
      "urgentMessages": 1, 
      "meetingsOrganizedCount": 0, 
      "meetingsAttendedCount": 0, 
      "adHocMeetingsOrganizedCount": 0, 
      "adHocMeetingsAttendedCount": 0, 
      "scheduledOneTimeMeetingsOrganizedCount": 0, 
      "scheduledOneTimeMeetingsAttendedCount": 0, 
      "scheduledRecurringMeetingsOrganizedCount": 0, 
      "scheduledRecurringMeetingsAttendedCount": 0, 
      "audioDuration": 00:00:00, 
      "videoDuration": 00:00:00, 
      "screenShareDuration": 00:00:00, 
      "hasOtherAction": true, 
      "reportPeriod": "7"
    }
  ]
}

Поделиться через

reportRoot: getTeamsUserActivityUserDetail

Разрешения

HTTP-запрос

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

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

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

Текст запроса

Отклик

CSV

JSON

Примеры

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

Запрос

Отклик

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

Запрос

Отклик

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

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