StaleMailboxDetail 报告
StaleMailboxDetail REST URI 提供有关 Office 365 组织中最近未访问的邮箱的详细信息。将此报告与 StaleMailbox 报告 结合使用可管理非活动状态的邮箱。
上次修改时间: 2015年9月17日
适用范围: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/StaleMailboxDetail[?ODATA options]
字段
可在 $select 和 $filter ODATA2 查询选项中指定下列字段。如果没有提供 $select 选项,将返回所有字段。条目始终按时间顺序返回,最后一个条目日期最近。
此报告不支持 $orderby 选项。
名称 |
WCF 类型* |
EDM 类型* |
[In/Out]** 说明 |
示例值 |
在其中添加的服务版本 |
---|---|---|---|---|---|
Date |
System.DateTime |
Edm.DateTime |
[In/Out] 报告条目的日期和时间。 请参阅"备注"部分,了解有关使用此字段的信息。 |
简写日期(例如,03/10/2013)或带引号的日期时间(例如,"03/10/2013 4:55 PM") |
2013-V1 |
DaysInactive |
int |
Edm.Int32 |
Date 字段中指定的日期中邮箱处于非活动状态的天数。如果用户从未登录邮箱,则该字段指示自邮箱创建后的天数。 |
25 |
2013-V1 |
LastLogin |
System.DateTime |
Edm.DateTime |
上次访问邮箱的日期和时间。如果始终未访问该邮箱,则该字段将明确为 null。 |
2012-09-27T16:44:57 |
2013-V1 |
TenantGuid |
System.guid |
Edm.Guid |
[In/Out] Office 365 组织的 GUID。 |
16a58f78-539f-47f7-b9bf-02a63867d73b |
2013-V1 |
TenantName |
string |
未指定 |
[In/Out] 组织的域名。 |
example.onmicrosoft.com |
2013-V1 |
UserName |
string |
未指定 |
[In/Out] 与邮箱关联的显示名称。 |
UserOne |
2013-V1 |
WindowsLiveID |
string |
未指定 |
[In/Out] 与邮箱关联的 Windows Live ID,采用 SMTP 电子邮件地址格式。 |
userone@example.onmicrosoft.com |
2013-V1 |
*WCF 类型指在 Visual Studio 中创建 Windows Communication Foundation (WCF) 服务参考时分配给字段的 .NET Framework 数据类型。EDM 类型指 Atom 格式化报告中返回的 ADO.NET 实体数据模型 (EDM) 类型。
**有关 [In/Out] 指示符的信息,请参阅"输入参数和报告输出列"部分。
备注
报告中的每个条目都包括元数据的多个字段。有关详细信息,请参阅 Office 365 报告 Web 服务返回的常见元数据。
控制报告期间
对于其他很多报告,可以通过使用 StartDate 和 EndDate 字段来控制报告时间段。此报告没有这些字段,而是使用单个 Date 字段来指定哪一天要报告非活动邮箱的详细信息。如果您未提供指定了 Date 的 $filter 选项,报告将默认为针对每个非活动邮箱提供过去 90 天的信息。通过该信息,您可以分析非活动邮箱数的趋势。
若要检索当前非活动邮箱的详细信息,请在 $filter 选项中使用昨天的日期。由于数据会稍微延迟进入数据市场,并且旧邮箱计数会在一整天结束时记录,因此会几乎永远不会有"今天"的数据。例如,如果今天为 2 月 14 日,您将按以下所示提供 $filter 选项。
...$filter=Date eq datetime'2013-02-13T00:00'
若要请求过去 14 天(假设今天是 2013 年 2 月 14 日)每一天的计数,请使用以下方法。
...$filter=Date ge datetime'2013-02-01T00:00'
StaleMailboxDetail 报告还支持 $top 选项。若要指定特定时间段,请使用这两个选项。以下示例返回 2013 年 1 月第一周期间的旧邮箱计数。
...$filter=Date ge datetime'2013-01-01T00:00'&$top=7
示例
以下请求和响应演示如何检索 2013 年 1 月 1 日处于非活动状态的邮箱的详细信息(采用基于 XML 的 Atom 格式)。为清楚起见,请求和响应中添加了换行符。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/StaleMailboxDetail?
$select=Date,DaysInactive,LastLogin,UserName,WindowsLiveID&
$filter=Date%20ge%20datetime'2013-01-01T00:00:00'&
$top=1&$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/StaleMailboxDetail</id>
<title type="text">StaleMailboxDetail</title>
<updated>2013-02-10T03:40:33Z</updated>
<link rel="self" title="StaleMailboxDetail" href="StaleMailboxDetail" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')</id>
<category term="TenantReporting.StaleMailboxDetailReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="StaleMailboxDetailReport" href="StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')" />
<title />
<updated>2013-02-10T03:40:33Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-11T00:00:00</d:Date>
<d:WindowsLiveID>userone@example.onmicrosoft.com</d:WindowsLiveID>
<d:UserName>UserOne</d:UserName>
<d:LastLogin m:type="Edm.DateTime" m:null="true" />
<d:DaysInactive m:type="Edm.Int32">115</d:DaysInactive>
</m:properties>
</content>
</entry>
</feed>
下列代码示例以 JSON 格式显示相同查询的结果。
{
"d":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')",
"type":"TenantReporting.StaleMailboxDetailReport"
},
"Date":"\/Date(1357862400000)\/",
"WindowsLiveID":"userone@example.onmicrosoft.com",
"UserName":"UserOne",
"LastLogin":null,
"DaysInactive":115
}
]
}
输入参数和报告输出列
字段表格中的 [In/Out] 指示符具有以下含义:
字段表中标记为 [In] 的字段主要在 $filter=、$orderby= 和其他限制报告应返回哪些条目的查询选项中使用。字段表中标记为 [In] 的字段可包含在 $select= 选项中,它们将在报告条目中出现,但不包含有用数据。
如上文所述,此报告不支持 $orderby 选项。
字段表中标记为 [In/Out] 的字段可在列选择 ($select=) 和条目限制 ($filter=) 选项中使用。当您在 $select= 选项中包含这些字段之一时,它们将在报告条目中出现,且将在提供时包含有用数据。
兼容性
StaleMailboxDetail 报告在 Office 365 服务版本 2013-V1 中引入。有关版本控制的详细信息,请参阅 Office 365 报告 Web 服务中的版本控制。
相应的 Windows PowerShell cmdlet
StaleMailboxDetail 报告将返回与 Get-StaleMailboxDetailReport Windows PowerShell cmdlet 相同的信息。
权限
您用于访问报告的帐户必须拥有该 Office 365 组织的管理权限。如果此帐户可以在 Office 365 控制面板中查看此报告,则此帐户具有从 REST Web 服务检索数据的权限。此报告要求为用户分配收件人(仅查看)角色。在默认的 Office 365 权限结构中,具有下列管理员权限的用户可以访问此报告:帐务管理员 、全局管理员、密码管理员、服务管理员和用户管理管理员。有关详细信息,请参阅MailboxUsage 报告。
数据粒度、持久性和可用性
通过此报告获取的信息每天收集一次。
此报告的信息适用于一年的时间,或者直到取消订阅为止。
事件可能被推迟达 24 小时,然后才能显示在报告中。