reportRoot: getTeamsUserActivityUserDetail

Статья
10/31/2023

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

Получение сведения о действиях отдельных пользователей 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-адресе необходимо указать либо период, либо дату.

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

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

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

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного выполнения этот метод возвращает отклик 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.

Пример

Запрос

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

GET https://graph.microsoft.com/v1.0/reports/getTeamsUserActivityUserDetail(period='D7')


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetTeamsUserActivityUserDetailWithPeriod("{period}").GetAsync();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc reports get-teams-user-activity-user-detail-with-period get --period {period-id}

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



period := "{period}"
graphClient.Reports().GetTeamsUserActivityUserDetailWithPeriod(&period).Get(context.Background(), nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getTeamsUserActivityUserDetailWithPeriod("{period}").get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getTeamsUserActivityUserDetail(period='D7')')
	.get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getTeamsUserActivityUserDetailWithPeriod('{period}', )->get()->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.reports.get_teams_user_activity_user_detail_with_period("{period}").get()

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

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

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

reportRoot: getTeamsUserActivityUserDetail

Разрешения

HTTP-запрос

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

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

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

Отклик

Пример

Запрос

Отклик

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

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

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