通过

reportRoot： getTeamsUserActivityTotalDistributionCounts

  • 项目

命名空间：microsoft.graph

重要

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

获取所选时间段内Microsoft Teams 用户活动的数量。 活动类型包括团队聊天消息、私人聊天消息、通话、会议、组织的会议、已参加的会议、音频持续时间、视频持续时间、屏幕共享持续时间、发布消息和答复消息。

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

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

权限

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

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

注意：若要获得委派权限以允许应用代表用户读取服务使用情况报告，租户管理员必须向用户分配适当的Microsoft Entra ID 受限管理员角色。 有关详细信息，请参阅 授权 API 读取Microsoft 365 使用情况报告。

HTTP 请求

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

函数参数

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

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

可选的查询参数

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

请求标头

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

请求正文

请勿提供此方法的请求正文。

响应

CSV

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

预身份验证的下载 URL 仅在短时间内有效， (几分钟) 不需要 Authorization 标头。

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

  • 报表刷新日期
  • 团队聊天消息
  • 专用聊天消息
  • 呼叫
  • 会议
  • 已组织的会议
  • 已参加的会议数
  • 音频持续时间
  • 视频持续时间
  • 屏幕共享持续时间
  • 发布消息
  • 回复消息
  • 报表周期

JSON

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

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

示例

示例 1：CSV 输出

下面是输出 CSV 的示例。

请求

下面是请求的示例。

GET https://graph.microsoft.com/beta/reports/getTeamsUserActivityTotalDistributionCounts(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,Team Chat Messages,Private Chat Messages,Calls,Meetings,Meetings Organized,Meetings Attended,Audio Duration,Video Duration,Screen Share Duration,Post Messages,Reply Messages,Report Period

示例 2：JSON 输出

下面是一个返回 JSON 的示例。

请求

下面是请求的示例。

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

响应

以下是响应示例。

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/getTeamsUserActivityTotalDistributionCounts(period='D7')?$format=application/json&$skiptoken=D07uj", 
  "value": [
      "reportRefreshDate": "2021-09-01", 
      "userCounts"
        {
          "reportPeriod":7,
          "teamChatMessages": 26, 
          "privateChatMessages": 17, 
          "calls": 4, 
          "meetings": 0, 
          "audioDuration": 00:00:00,
          "videoDuration": 00:00:00,
          "screenShareDuration": 00:00:00,
          "meetingsOrganized": 0,
          "meetingsAttended": 0,
          "postMessages": 1,
          "replyMessages": 1
    }
  ]
}