reportRoot: getEmailActivityCounts
命名空间:microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
可便于了解组织中的电子邮件活动趋势(如已发送、已阅读和已接收的电子邮件数)。
备注: 若要了解不同报表视图和名称的详细信息,请参阅 Microsoft 365 报表 - 邮箱活动况。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 | 权限(从最低特权到最高特权) |
|---|---|
| 委派(工作或学校帐户) | Reports.Read.All |
| 委派(个人 Microsoft 帐户) | 不支持。 |
| 应用 | Reports.Read.All |
注意:若要获得委派权限以允许应用代表用户读取服务使用情况报告,租户管理员必须事先为用户分配适当的 Azure AD 受限管理员角色。有关更多详细信息,请参阅 API 授权,读取 Microsoft 365使用情况报告。
HTTP 请求
GET /reports/getEmailActivityCounts(period='{period_value}')
函数参数
在请求 URL 中,提供以下参数的有效值。
| 参数 | 类型 | 说明 |
|---|---|---|
| period | string | 指定在多长时间内聚合报表。 受支持的 {period_value} 值为:D7、D30、D90 和 D180。 这些值采用格式 D n,其中 n 表示在多少天内聚合报表。 必需。 |
此方法支持使用 $format OData 查询参数自定义响应。 默认输出类型为 text/csv。 但是,如果要指定输出类型,可以使用将 OData $format查询参数设置为 text/csv 或 application/json。
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | Bearer {token}。必需。 |
响应
CSV
如果成功,此方法返回 302 Found 响应,以重定向到报表的预先验证的下载 URL。 可以在响应的 Location 头中找到此 URL。
预先验证的下载 URL 的有效时间很短(几分钟),不需要 Authorization 头。
CSV 文件包含下面的列标题。
- 报表刷新日期
- 已发送
- 已接收
- 已阅读
- 已创建会议
- 会议交互
- 报表日期
- 报表周期
JSON
如果成功,此方法在响应正文中返回 200 OK 响应代码和 JSON 对象。
示例
CSV
下面是输出 CSV 的示例。
请求
下面展示了示例请求。
GET https://graph.microsoft.com/beta/reports/getEmailActivityCounts(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,Send,Receive,Read,Meeting Created,Meeting Interacted,Report Date,Report Period
JSON
下面是返回 JSON 的示例。
请求
下面展示了示例请求。
GET https://graph.microsoft.com/beta/reports/getEmailActivityCounts(period='D7')?$format=application/json
响应
下面展示了示例响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 242
{
"value": [
{
"reportRefreshDate": "2017-09-01",
"send": 504,
"receive": 76506,
"read": 12161,
"meetingCreated": 421,
"meetingInteracted": 7930,
"reportDate": "2017-09-01",
"reportPeriod": "7"
}
]
}
反馈
提交和查看相关反馈