reportRoot: getOneDriveUsageAccountCounts

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

获取 OneDrive for Business 活跃网站数趋势。 用户在其中查看、修改、上传、下载、共享或同步文件的任何网站都被视为活跃网站。

注意:有关不同报表视图和名称的详细信息,请参阅 Microsoft 365 报表 - OneDrive for Business使用情况

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Reports.Read.All 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用 Reports.Read.All 不可用。

注意:对于允许应用代表用户读取服务使用情况报告的委托权限,租户管理员必须向用户分配适当的Microsoft Entra ID受限管理员角色。 有关更多详细信息,请参阅授权 API 读取 Microsoft 365 使用情况报告

HTTP 请求

GET /reports/getOneDriveUsageAccountCounts(period='{period_value}')

函数参数

在请求 URL 中,提供以下参数的有效值。

参数 类型 说明
period string 指定在多长时间内聚合报表。 受支持的 {period_value} 值为:D7、D30、D90 和 D180。 这些值采用格式 Dn,其中 n 表示在多少天内聚合报表。 必需。

此方法支持 $formatOData 查询参数 来自定义响应。 默认输出类型为 text/csv。 但是,如果要指定输出类型,可以使用 OData $format查询参数设置为 text/csv 或 application/json。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

响应

CSV

如果成功,此方法返回 302 Found 响应,以重定向到报表的预先验证的下载 URL。 可以在响应的 Location 头中找到此 URL。

预先验证的下载 URL 的有效时间很短(几分钟),不需要 Authorization 头。

CSV 文件包含下面的列标题。

  • 报表刷新日期
  • 网站类型
  • 总计
  • 活跃
  • 报表日期
  • 报表周期

JSON

如果成功,此方法在 200 OK 响应正文中返回响应代码和 JSON 对象。

示例

CSV

下面是输出 CSV 的示例。

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/beta/reports/getOneDriveUsageAccountCounts(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 Type,Total,Active,Report Date,Report Period

JSON

下面是返回 JSON 的示例。

请求

以下示例显示了一个请求。

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

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "siteType": "All", 
      "total": 207, 
      "active": 89, 
      "reportDate": "2017-09-01", 
      "reportPeriod": "7"
    }
  ]
}