MailboxActivity* 报告
MailboxActivity* REST URI 提供了有关创建和删除 Office 365 组织邮箱的概要统计。共有四个报告使用同一个整体结构,它们仅在汇总数据使用的时间间隔(每日、每周、每月和每年)上有区别。为简单起见,本主题中详细说明了这四个报告。
上次修改时间: 2015年9月17日
适用范围: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityDaily[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityWeekly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityMonthly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityYearly[?ODATA options]
字段
可在 $select、$filter 和 $orderby ODATA2 查询选项中指定下列字段。如果没有提供 $select 选项,将返回所有字段。
名称 |
WCF 类型* |
EDM 类型* |
[In/Out]** 说明 |
示例值 |
在其中添加的服务版本 |
---|---|---|---|---|---|
Date |
System.DateTime |
Edm.DateTime |
[In/Out] 报告期间的结束日期和时间。请参阅下文,获取有关报告期间的详细信息。 |
简写日期(例如,03/10/2013)或带引号的日期时间(例如,"03/10/2013 4:55 PM") |
2013-V1 |
AccountCreated |
long |
Edm.Int64 |
[In/Out] 该时间段内创建的 Office 365 邮箱数。 |
265 |
2013-V1 |
AccountDeleted |
long |
Edm.Int64 |
[In/Out] 该时间段内删除的 Office 365 邮箱数。 |
72 |
2013-V1 |
TenantGuid |
System.guid |
Edm.Guid |
[In/Out] 组织的 GUID。 |
16a58f78-539f-47f7-b9bf-02a63867d73b |
2013-V1 |
TenantName |
string |
未指定 |
[In/Out] 组织的域名。 |
example.onmicrosoft.com |
2013-V1 |
TotalNumberOfActiveMailboxes |
long |
Edm.Int64 |
[In/Out] 报告期间处于活动状态的邮箱总数。 |
1242 |
2013-V1 |
*WCF 类型指在 Visual Studio 中创建 Windows Communications Framework (WCF) 服务参考时分配给字段的 .NET Framework 数据类型。EDM 类型指 ATOM 格式化报告中返回的 ADO.NET 实体数据模型 (EDM) 类型。
**[In/Out]:请参阅"输入参数和报告输出列"部分。
备注
报告中的每个条目都包含元数据的多个字段。有关详细信息,请参阅 Office 365 报告 Web 服务返回的常见元数据。
四个报告类型仅是每个报告条目涵盖的时间量不同。"日期"字段中报告的时间表示时间段的结束。日期和时间按 HTTPS GET X-timezone 标头指定的时区报告。如果没有指定时区,则使用 UTC 时间。报告的持续时间以下列方式计算:
报告名称 |
时间段计算 |
---|---|
每日 (GroupActivityDaily) |
报告日精确始于午夜 (00:00:00) 并在当天即将午夜前 (23.59:59.9999...) 结束。报告的最后一天是所提供数据的最后一整天,将不包含当日。Date 字段中返回的日期和时间表示该报告日的结束。 |
每周 (GroupActivityWeekly) |
报告周精确始于星期六凌晨午夜 (00:00:00),并在下一周星期五晚上即将午夜前 (23:59:59.9999...) 结束。最近报告的条目包含当日的条目,因此通常延长到请求报告的时间之外。Date 字段中返回的日期和时间表示该报告周的结束。 |
每月 (GroupActivityMonthly) |
报告月精确始于每月第一天午夜 (00:00:00),并在当月最后一个日历日即将午夜前 (23:59:59.9999...) 结束。最近报告的条目包含当日的条目,因此通常延长到请求报告的时间之外。 Date 字段中返回的日期和时间表示该报告月的结束。 |
每年 (GroupActivityYearly) |
报告年精确始于该日历年的 1 月 1 日午夜 (00:00:00),并在当年 12 月 31 日即将午夜前 (23:59:59.9999...) 结束。最近报告的条目包含当日的条目,因此通常延长到请求报告的时间之外。 Date 字段中返回的日期和时间表示该报告月的结束。 |
示例
下面的请求和响应对演示如何检索 JSON 格式的每月邮箱活动报告。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityMonthly?$format=Json
{
"d":
{
"results":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-11-30T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-11-30T00%3A00%3A00')",
"type":"TenantReporting.MailboxActivityReport"
},
"TenantGuid":"16a58f78-5e9f-47f7-bebf-02ae3867d73b",
"TenantName":"example.onmicrosoft.com",
"Date":"\/Date(1354233600000)\/",
"TotalNumberOfActiveMailboxes":"0",
"AccountCreated":"0",
"AccountDeleted":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-12-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-12-31T00%3A00%3A00')",
"type":"TenantReporting.MailboxActivityReport"
},
"TenantGuid":"16a58f78-5e9f-47f7-bebf-02ae3867d73b",
"TenantName":"example.onmicrosoft.com",
"Date":"\/Date(1356912000000)\/",
"TotalNumberOfActiveMailboxes":"0",
"AccountCreated":"0",
"AccountDeleted":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2013-01-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2013-01-31T00%3A00%3A00')",
"type":"TenantReporting.MailboxActivityReport"
},
"TenantGuid":"16a58f78-5e9f-47f7-bebf-02ae3867d73b",
"TenantName":"example.onmicrosoft.com",
"Date":"\/Date(1359590400000)\/",
"TotalNumberOfActiveMailboxes":"1",
"AccountCreated":"0",
"AccountDeleted":"0"
}
]
}
}
以下请求和响应对演示如何检索前四天中每天处于活动状态的邮箱总数,以反向时间顺序排列。此查询请求 Date 和 TotalNumberOfActiveMailboxes 计数,并且请求 Atom 格式的信息。为清楚起见,请求和响应中添加了换行符。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityDaily?
$select=Date,TotalNumberOfActiveMailboxes&
$top=4&
$orderby=Date%20desc&
$format=Atom
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/"
xmlns="http://www.w3.org/2005/Atom"
xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices"
xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityDaily</id>
<title type="text">MailboxActivityDaily</title>
<updated>2013-01-31T05:23:09Z</updated>
<link rel="self" title="MailboxActivityDaily" href="MailboxActivityDaily" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-29T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-29T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-28T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-28T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-28T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-27T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-27T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-27T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-26T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-26T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-26T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
</feed>
输入参数和报告输出列
字段表格中的 [In/Out] 指示符具有以下含义:
字段表中标记为 [In] 的字段主要在 $filter=、$orderby= 和其他限制报告应返回哪些条目的查询选项中使用。字段表中标记为 [In] 的字段可包含在 $select= 选项中,它们将在报告条目中出现,但不包含有用数据。
字段表中标记为 [In/Out] 的字段可在列选择 ($select=) 和条目限制($filter= 和 $orderby=)选项中使用。当您在 $select= 选项中包含这些字段之一时,它们将在报告条目中出现,且将在提供时包含有用数据。
兼容性
MailboxActivityDaily、MailboxActivityWeekly、MailboxActivityMonthly 和 MailboxActivityYearly 报告在 Office 365 服务版本 2013-V1 中引入。有关版本控制的详细信息,请参阅 Office 365 报告 Web 服务中的版本控制。
相应的 PowerShell cmdlet
MailboxActivity* 报告将返回与 Get-MailboxActivityReport Windows PowerShell cmdlet 相同的信息。
权限
您用于访问报告的帐户必须拥有该 Office 365 组织的管理权限。如果此帐户可以在 Office 365 控制面板中查看此报告,则此帐户具有从 REST Web 服务检索数据的权限。此报告要求为用户分配收件人(仅查看)角色。在默认的 Office 365 权限结构中,具有下列管理员权限的用户可以访问此报告:帐务管理员 、全局管理员、密码管理员、服务管理员和用户管理管理员。
数据粒度、持久性和可用性
通过这些报告提供的信息可分隔为多个一天的时间段,从调用应用程序在 HTTP X-timezone 标头中报告的时区的午夜开始。
此报告的信息适用于一年的时间,或者直到取消订阅为止。
事件可能被推迟达 24 小时,然后才能显示在报告中。