Отчет о MailTrafficTop
MailTrafficTop REST URI содержит сводную информацию о пользователях, отправка и получение наибольшее количество сообщений электронной почты в организации. Начальная и конечная дата и время отчета можно указать в запросе, можно периода времени, для которого сводных данных.
Дата последнего изменения: 17 сентября 2015 г.
Область применения: Office 365
Коды URI REST
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop[?ODATA options]
Поля
В $select, $filterи $orderby параметры запроса ODATA2 можно указать следующие поля. Если указан параметр $select не возвращаются все поля.
Имя |
WCF тип * |
Тип EDM * |
[В/Out] ** описание |
Пример значения |
Добавлено в версию обновления |
---|---|---|---|---|---|
AggregateBy |
строка |
Не задан |
[In] Указывает, следует ли для объединения данных в отчет операции, которые затрагивают вопросы полного дня. Только $filter приведены значения параметра допускается Day и Hour. Если не задан, отчет объединяет за периодов 1 час. Если функция входит в параметре $select , это поле всегда возвращает null. Для получения дополнительных сведений в разделе «Замечания». |
Day или Hour |
2013-V1 |
Date |
System.DateTime |
Edm.DateTime |
[In/Out] Дата и время сообщение распознано как нежелательная почта. |
Краткий формат даты (например, 03/10/2013) или Дата и время в кавычки (например, "03/10/2013 4:55 PM") |
2013-V1 |
Direction |
строка |
Не задан |
[In/Out] Указывает, было ли сообщение электронной почты отправляется (Inbound) или от (Outbound) организации, когда он был обнаружен как нежелательной почты. |
Значения ограничены Inbound и Outbound |
2013-V1 |
Domain |
строка |
Не задан |
[In/Out] Полное доменное имя, которое обработки электронной почты. |
example.onmicrosoft.com |
2013-V1 |
EndDate |
System.DateTime |
Edm.DateTime |
[In] Это поле используется для ограничения периода отчета. Используйте это поле в параметр запроса $filter для задания Дата и время окончания отчетного периода. Если вы задаете EndDate в параметре $filter , необходимо также указать StartDate. |
Краткий формат даты (например, 03/10/2013) или Дата и время в кавычки (например, "03/10/2013 4:55 PM") |
2013-V1 |
EventType |
строка |
Не задан |
[In/Out] Тип сканирования зарегистрированные события. Сведения о значениях допустимый EventTypeОтчет о MailFilterListсм. |
SpamContentFiltered, SpamIPBlock |
2013-V1 |
MessageCount |
int |
Edm.Int64 |
[In/Out] Число сообщений, которые соответствуют категорий, указанный в параметре другие поля, в течение периода статистической обработки. |
1254 |
2013-V1 |
Name |
строка |
Не задан |
Адрес электронной почты SMTP пользователя, связанного с сообщениями, в записи отчета. |
userone@example.com |
2013-V1 |
Organization |
строка |
Не задан |
[In/Out] Полное доменное имя, которое обработки электронной почты. |
example.onmicrosoft.com |
2013-V1 |
StartDate |
System.DateTime |
Edm.DateTime |
[In] Это поле используется для ограничения периода отчета. Это поле в параметр запроса $filter используется для задания даты начала и время отчетного периода. При предоставлении StartDate в параметре $filter , необходимо также указать EndDate. |
Краткий формат даты (например, 03/10/2013) или Дата и время в кавычки (например, "03/10/2013 4:55 PM") |
2013-V1 |
SummarizeBy |
строка |
Не задан |
[In] Поле отчета, указанного в параметре $filter , с помощью этого поля определяет, как объединить записи отчета для формирования сводки. Для получения дополнительных сведений в разделе «Замечания». Если функция входит в параметре $select , это поле всегда возвращает null. |
Action, EventType, Domainи Direction являются единственными допускаются значения, которые могут использоваться в параметре $filter с этим полем |
2013-V1 |
* Тип WCF относится к типу данных .NET Framework, назначенные в поле при создании Windows Communication Foundation (WCF) ссылки на службу в Visual Studio. Имя относится к модели данных ADO.NET сущности (EDM) типов, которые возвращаются в формате Atom отчеты.
** Сведения о [In/Out] индикаторов, см в разделе «Входные параметры и сообщить о выходных столбцов».
Замечания
Каждый элемент в отчете о включает несколько полей метаданных. Для получения дополнительных сведений см Распространенные метаданных, возвращаемых веб-службой отчетов Office 365.
Поле Date указывает, когда сообщения обрабатывались системой Office 365 и сообщает в часовом поясе из этих серверов.
Параметр $orderby ODATA не работает с помощью этого отчета.
С помощью StartDate и EndDate
Поля StartDate и EndDate не получать полезную информацию в отчет о результатах и всегда значение 0001-01-01T00:00:00Z в выходные данные отчета. Они предназначены для включить простой ограничение отчетов временной интервал, а также предоставлять большая точность не будет доступен в отчете «день».
Это может быть особенно полезны, например, при записи на основе электронной почты атак типа "отказ в обслуживании" на основе каждый час. При использовании этих полей, необходимо включить оба параметра $filter . Они оба считаются необязательные, но если один, которые необходимо указать другое. Если пара StartDate и EndDate не указан в запросе, отчетного периода времени по умолчанию — это предыдущие две недели. В разделе «Примеры» далее в этом разделе показано, как использовать поля StartDate и EndDate .
С помощью поля AggregateBy
Отчет о MailTrafficTop возвращает сводки пользователей количество наибольший сообщений Office 365 системы. Каждое событие записывается с Action, Event, Date, Senderи т. д. Данные, записанные с Office 365 включает в себя точное дату и время каждого события. «Подробности» отчеты, такие как MailDetailMalware предоставить списки событий и их точное время. «Трафика» отчеты, такие как MailTrafficTopсведение и может предоставить счетчика событий на двух длительности: час и дня. Какие длительности для использования в параметре $filter запроса укажите, как показано в следующем примере. Если нет сравнения AggregateBy входит в параметр $filter , используется по умолчанию Hour .
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop?$filter=AggregateBy eq 'Day'
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop?$filter=AggregateBy eq 'Hour'
С помощью поля SummarizeBy
В поле SummarizeBy позволяет "Свернуть" выходные данные отчета на имя указанного поля. Например предположим, выполнялись 200 входящих и 100 исходящие сообщения электронной почты во время одного отчетного периода длительностью в день. Если запрос содержит $filter=AggregateBy eq ‘Day’, отчет вернет две отдельные записи для этого дня: одна для входящей электронной почты, отражающая MessageCount 200 и DirectionInboundи еще одну запись для исходящих сообщений электронной почты, отражающая MessageCount 100 и Direction из Outbound. При указании поля SummarizeBy в параметре $filter , как и в SummarizeBy eq ‘Direction’отчет нажмите будет включать только одна запись для этого дня, с полем пустой Direction и MessageCount 300. В поле Направление пуст, так как операция приведена сводка по обоих Direction eq ‘Inbound’ сообщение, которое подсчитывает число и Direction eq ‘Outbound’ сообщения друг с другом.
Для использования с SummarizeByподдерживаются только следующие поля.
Action
EventType
Direction
Domain
Запросы могут включать несколько полей, разрешенных в целом, как и следующий параметр $filter .
$filter=SummarizeBy eq 'EventType,Action'
Если запрос использует SummarizeBy на поле, а также включает имя этого поля в параметре $select , поле всегда должны отображаться с пустым значением.
Следующий запрос показано, как запросить сводку день пользователей верхней электронной почты с только что Name, Date, Directionи MessageCount поля возвращаются. Результатом будет суммировать по дням. Разрывы были добавлены в запрос для наглядности.
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop?
$select= Date,Name,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'&
$format=Atom
Ниже показаны результаты запроса. Чтобы упростить результаты, наиболее распространенные элементы метаданных будут удалены. Примечание: две записи, с DirectionInboundи другое на один день с Direction из Outbound.
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/">
<id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop</id>
<title type="text">MailTrafficTop</title>
<entry>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
<d:Name>userone@example.onmicrosoft.com</d:Name>
<d:Direction>Name</d:Direction>
<d:MessageCount m:type="Edm.Int32">55</d:MessageCount>
</m:properties>
</content>
</entry>
<entry>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
<d:Name>userone@example.onmicrosoft.com</d:Name>
<d:Direction>Outbound</d:Direction>
<d:MessageCount m:type="Edm.Int32">4</d:MessageCount>
</m:properties>
</content>
</entry>
</feed>
Если же запроса с добавлением Подведение итогов с Direction, запрос становится следующее.
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop?
$select=Date,Name,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'%20and%20SummarizeBy%20eq%20'Direction'&
$format=Atom
Ответ на этот же день сворачивает или обобщаются поля Direction . Другими словами она объединяет счетчики для всех записей, которые отличаются только в их значения поля Direction . Элемент Direction возвращаются в виде пустой, указывающего на то, что запись отчета объединяет счетчики строк для событий, без учета Direction значениями.
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/">
<id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop</id>
<title type="text">MailTrafficTop</title>
<entry>
<content type="application/xml">
<m:properties>
<d:Direction>Inbound</d:Direction>
<d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
<d:Name>userone@example.onmicrosoft.com</d:Name>
<d:Direction>
</d:Direction>
<d:MessageCount m:type="Edm.Int32">59</d:MessageCount>
</m:properties>
</content>
</entry>
</feed>
Примеры
Следующем примере показано, как получить сведения о верхней учетные записи трех пользователей, которые получены большинство электронной почты на 6 февраля 2013 г., в формате Atom. Для запроса и ответа для ясности были добавлены символы перевода строки.
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop?
$select=Name,Date,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'%20and%20
StartDate%20eq%20datetime'2013-02-06T00:00:00Z'%20and%20
EndDate%20eq%20datetime'2013-02-07T00:00:00Z'%20and%20
Direction%20eq%20'Inbound'&
$orderby=MessageCount&
$top=3&
$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/MailTrafficTop</id>
<title type="text">MailTrafficTop</title>
<updated>2013-02-09T16:19:53Z</updated>
<link rel="self" title="MailTrafficTop" href="MailTrafficTop" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(0)</id>
<category term="TenantReporting.MailTrafficTopReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficTopReport" href="MailTrafficTop(0)" />
<title />
<updated>2013-02-09T16:19:53Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-02-06T00:00:00</d:Date>
<d:Name>userone@example.onmicrosoft.com</d:Name>
<d:Direction>Inbound</d:Direction>
<d:MessageCount m:type="Edm.Int32">1</d:MessageCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(1)</id>
<category term="TenantReporting.MailTrafficTopReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficTopReport" href="MailTrafficTop(1)" />
<title />
<updated>2013-02-09T16:19:53Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-02-06T00:00:00</d:Date>
<d:Name>usertwo@example.onmicrosoft.com</d:Name>
<d:Direction>Inbound</d:Direction>
<d:MessageCount m:type="Edm.Int32">71</d:MessageCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(2)</id>
<category term="TenantReporting.MailTrafficTopReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficTopReport" href="MailTrafficTop(2)" />
<title />
<updated>2013-02-09T16:19:53Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-02-06T00:00:00</d:Date>
<d:Name>userthree@example.onmicrosoft.com</d:Name>
<d:Direction>Inbound</d:Direction>
<d:MessageCount m:type="Edm.Int32">6</d:MessageCount>
</m:properties>
</content>
</entry>
</feed>
Ниже представлены же отчетов результаты в формате JSON.
{
"d":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(0)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(0)",
"type":"TenantReporting.MailTrafficTopReport"
},
"Date":"\/Date(1360108800000)\/",
"Name":"useone@example.onmicrosoft.com",
"Direction":"Inbound",
"MessageCount":1
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(1)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(1)",
"type":"TenantReporting.MailTrafficTopReport"
},
"Date":"\/Date(1360108800000)\/",
"Name":"usetwo@example.onmicrosoft.com",
"Direction":"Inbound",
"MessageCount":71
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(2)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficTop(2)",
"type":"TenantReporting.MailTrafficTopReport"
},
"Date":"\/Date(1360108800000)\/",
"Name":"usethree@example.onmicrosoft.com",
"Direction":"Inbound",
"MessageCount":6
}
]
}
Входные параметры и сообщить о выходных столбцов
[In/Out] индикаторов в таблице полей имеют следующие значения:
Поля, отмеченные [In] в таблице предназначены для использования в $filter=, $orderby=, поля и другие параметры запроса, ограничить вводимых данных в отчете. Поля, помеченные [In] в таблице поля могут быть включены в параметр $select= и они будут отображаться в отчет операции, но они будут не содержат полезных данных.
Поля, отмеченные [In/Out] в поля, которые в таблице можно использовать в выделенный фрагмент столбца ($select=) и параметры ($filter= и $orderby=) ограничение записей. При включении эти поля параметр $select= будет отображаться в отчет операции и будет содержать полезные данные, если она доступна.
Совместимость
Отчет о MailTrafficTop была введена в Служба Office 365 версии 2013-V1. Дополнительные сведения об управлении версиями содержатся в разделе Управление версиями в веб-службе отчетов Office 365.
Соответствующий командлетов Windows PowerShell
Отчет о MailTrafficTop возвращает те же данные в командлет Get-MailTrafficTopReportWindows PowerShell.
Разрешения
Учетная запись, используемая для доступа к отчетам необходимо иметь права администратора в организации Office 365. Если учетная запись может просмотреть этот отчет в Office 365 панель управления, учетная запись имеет разрешения для извлечения данных из веб-службы REST. В этом отчете требует от пользователя быть назначена роль получателей только для просмотра. В структуре разрешения по умолчанию Office 365 пользователей со следующими разрешениями администратора может вызвать этот отчет: выставления счетов администратора, глобального администратора, пароль администратора, администратора служб и администратор управления пользователями.
Степень детализации данных, сохранение состояния и доступности
Сведения о доступных в данном отчете хранятся с точным даты и времени для каждого события. Можно использовать любой период реального времени и длительность, включая поля StartDate и EndDate в параметре $filter . Время отображается в часовом поясе сервера сканирования сообщение электронной почты. В этом отчете вычисляет подсчитывает сообщения через дни или часы, в зависимости от того, в поле AggregateBy .
Сведения для этого отчета можно найти в течение 14 дней или до отмены подписки.
События с задержкой в течение 24 часов, прежде чем они отображаются в отчете.