reportRoot: getTeamsDeviceUsageUserDetail

命名空间:microsoft.graph

重要

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

按用户获取有关 Microsoft Teams 设备使用情况的详细信息。

权限

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

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

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

HTTP 请求

GET /reports/getTeamsDeviceUsageUserDetail(period='{period_value}')
GET /reports/getTeamsDeviceUsageUserDetail(date='{date_value}')

函数参数

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

参数 类型 说明
period string 指定在多长时间内聚合报表。 {period_value} 支持的值为: D7、 和 D90``D30``D180. 这些值采用格式 D n,其中 n 表示在多少天内聚合报表。
date Date 指定要查看用户在哪个日期执行的任何活动。 {date_value} 必须采用格式 YYYY-MM-DD。 由于此报表仅供过去 28 天使用,因此 {date_value} 应为该范围的日期。

注意: 需要在 URL 中设置 句点日期

可选的查询参数

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

请求标头

名称 说明
Authorization Bearer {token}。必需。

响应

CSV

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

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

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

  • 报表刷新日期
  • User Id
  • 用户主体名称
  • 上次活动日期
  • 已删除
  • 删除日期
  • 使用的 Web
  • 使用的 Windows 手机
  • 使用的 iOS
  • 使用的 Mac
  • 使用的 Android 手机
  • 使用的 Windows
  • 已使用的 Chrome OS
  • 已使用 Linux
  • 已获得许可
  • 报表周期

JSON

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

此请求的默认页面大小为 2000 个项目。

示例

示例 1:CSV 输出

下面是输出 CSV 的示例。

请求

下面展示了示例请求。

GET https://graph.microsoft.com/beta/reports/getTeamsDeviceUsageUserDetail(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,User Id,User Principal Name,Last Activity Date,Is Deleted,Deleted Date,Used Web,Used Windows Phone,Used iOS,Used Mac,Used Android Phone,Used Windows,Used Chrome OS,Used Linux,Is Licensed,Report Period

示例 2:JSON 输出

下面是返回 JSON 的示例。

请求

下面展示了示例请求。

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

响应

下面展示了示例响应。

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

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

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "userId": "userId-value", 
      "userPrincipalName": "userPrincipalName-value", 
      "isLicensed": true, 
      "lastActivityDate": "2017-09-01", 
      "isDeleted": false, 
      "deletedDate": null, 
      "usedWeb": false, 
      "usedWindowsPhone": false, 
      "usediOS": true, 
      "usedMac": false, 
      "usedAndroidPhone": false, 
      "usedWindows": true, 
      "usedChromeOS": false, 
      "usedLinux": false, 
      "reportPeriod": "7"
    }
  ]
}