reportRoot: getSharePointSiteUsageDetail
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получите сведения об использовании сайтов SharePoint.
Примечание: Дополнительные сведения о различных представлениях и именах отчетов см. в статье Отчеты Microsoft 365 — использование сайта SharePoint.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | Reports.Read.All | Недоступно. |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Для приложений | Reports.Read.All | Недоступно. |
Примечание. Чтобы делегированные разрешения разрешали приложениям читать отчеты об использовании служб от имени пользователя, администратор клиента должен назначить пользователю соответствующую Microsoft Entra ID ограниченную роль администратора. Дополнительные сведения см. в разделе Авторизация api для чтения отчетов об использовании Microsoft 365.
HTTP-запрос
GET /reports/getSharePointSiteUsageDetail(period='{period_value}')
GET /reports/getSharePointSiteUsageDetail(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 (Дата обновления отчета);
- Идентификатор сайта
- URL-адрес сайта
- "Owner Display Name" (Отображаемое имя владельца);
- Is Deleted (удален)
- Last Activity Date (Дата последнего действия);
- Идентификатор метки конфиденциальности сайта
- Внешний общий доступ
- Политика неуправляемых устройств
- Географическое расположение
- "File Count" (Количество файлов);
- "Active File Count" (Количество активных файлов);
- "Page View Count" (Количество просмотров страницы);
- "Visited Page Count" (Количество посещенных страниц);
- Число анонимных ссылок
- Количество ссылок компании
- Secure Link For Guest Count
- Secure Link For Member Count
- Storage Used (Byte) [использовано (байт)]
- "Storage Allocated (Byte)" (Объем выделенного хранилища в байтах);
- "Root Web Template" (Шаблон корневого веб-сайта);
- Owner Principal Name (имя участника-владельца)
- "Report Period" (Отчетный период).
JSON
В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект JSON в тексте отклика.
Размер страницы по умолчанию для этого запроса — 200 элементов.
Пример
CSV
Ниже приведен пример вывода CSV-файла.
Запрос
Ниже приведен пример запроса.
GET https://graph.microsoft.com/beta/reports/getSharePointSiteUsageDetail(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,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,Site Sensitivity Label Id,External Sharing,Unmanaged Device Policy,Geo Location,File Count,Active File Count,Page View Count,Visited Page Count,Anonymous Link Count,Company Link Count,Secure Link For Guest Count,Secure Link For Member Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period
JSON
Ниже приведен пример, возвращающий JSON.
Запрос
Ниже приведен пример запроса.
GET https://graph.microsoft.com/beta/reports/getSharePointSiteUsageDetail(period='D7')?$format=application/json
Отклик
Ниже приведен пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 484
{
"value": [
{
"reportRefreshDate": "2017-09-01",
"siteId": "siteId-value",
"siteUrl": "siteUrl-value",
"ownerDisplayName": "ownerDisplayName-value",
"ownerPrincipalName": "ownerPrincipalName-value",
"isDeleted": false,
"lastActivityDate": "2017-09-01",
"siteSensitivityLabelId": "SiteSensitivityLabelId-value",
"externalSharing": false,
"unmanagedDevicePolicy": "UnmanagedDevicePolicy-value",
"geoLocation": "GeoLocation-value",
"fileCount": 170,
"activeFileCount": 25,
"pageViewCount": 7,
"visitedPageCount": 3,
"anonymousLinkCount": 5,
"companyLinkCount": 8,
"secureLinkForGuestCount": 13,
"secureLinkForMemberCount": 11,
"storageUsedInBytes": 63442116,
"storageAllocatedInBytes": 2748779094400,
"rootWebTemplate": "Publishing Site",
"reportPeriod": "7"
}
]
}
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по