reportRoot: getSharePointSiteUsageDetail
命名空间：microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
获取 SharePoint 网站使用情况的详细信息。
注意： 有关不同报告视图和名称的详细信息，请参阅Microsoft 365 报告 -SharePoint使用率。
权限
要调用此 API，需要以下权限之一。要了解详细信息，包括如何选择权限的信息，请参阅权限。
| 权限类型 | 权限（从最低特权到最高特权） |
|---|---|
| 委派（工作或学校帐户） | Reports.Read.All |
| 委派（个人 Microsoft 帐户） | 不支持。 |
| 应用 | Reports.Read.All |
注意：若要获得委派权限以允许应用代表用户读取服务使用情况报告，租户管理员必须事先为用户分配适当的 Azure AD 受限管理员角色。有关更多详细信息，请参阅 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。 这些值采用格式 D n，其中 n 表示在多少天内聚合报表。 |
| date | Date | 指定要查看用户在哪个日期执行的任何活动。 {date_value} 必须采用格式 YYYY-MM-DD。 因为此报表的有效期仅为过去 30 天，所以 {date_value} 应为这个范围内的日期。 |
注意： 需要在 URL 中设置 period 或 date。
此方法支持使用 $format、$top 和 $skipToken OData 查询参数自定义响应。 默认输出类型为 text/csv。 但是，如果要指定输出类型，可以使用 OData 查询参数$format text/csv 或 application/json。
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | Bearer {token}。必需。 |
响应
CSV
如果成功，此方法返回 302 Found 响应，以重定向到报表的预先验证的下载 URL。 可以在响应的 Location 头中找到此 URL。
预先验证的下载 URL 的有效时间很短（几分钟），不需要 Authorization 标头。
CSV 文件包含下面的列标题：
- 报表刷新日期
- 网站 ID
- 网站 URL
- 所有者显示名称
- 已删除
- 上次活动日期
- 网站敏感度标签 ID
- 外部共享
- 非托管设备策略
- 地理位置
- 文件数
- 活跃文件数
- 页面浏览量
- 访问过的页面数
- 匿名链接计数
- 公司链接计数
- 来宾计数的安全链接
- 成员计数的安全链接
- 已使用的存储（字节）
- 已分配的存储（字节）
- 根网站模板
- 所有者主体名称
- 报表周期
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"
}
]
}
反馈
提交和查看相关反馈