Отчет о MailTrafficPolicy
MailTrafficPolicy REST URI содержит сводную информацию о трафике почты в организацию и из нее. Начальная и конечная дата и время отчета можно указать в запросе, можно периода времени, для которого сводных данных.
Дата последнего изменения: 17 сентября 2015 г.
Область применения: Office 365
Коды URI REST
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic[?ODATA options]
Поля
В $select, $filterи $orderby параметры запроса ODATA2 можно указать следующие поля. Если указан параметр $select не возвращаются все поля.
Имя |
WCF тип * |
Тип EDM * |
[В/Out] ** описание |
Пример значения |
Добавлено в версию обновления |
---|---|---|---|---|---|
Action |
строка |
Не задан |
[In/Out] Описание действие, выполняемое в окне сообщения при их наличии. В этом поле может быть пустой или значение null, если было выполнено никаких действий. Сведения о допустимых значений действие Отчет о MailFilterListсм. |
SetSpamConfidenceLevel, RejectMessage |
2013-V1 |
AggregateBy |
строка |
Не задан |
[In] Указывает, следует ли для объединения данных в отчет операции, которые затрагивают вопросы полного дня. Только $filter приведены значения параметра допускается Day и Hour. Если функция входит в параметре $select , это поле всегда возвращает null. Если не задан, отчет объединяет за периодов 1 час. Для получения дополнительных сведений в разделе «Замечания». |
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 |
DlpPolicy |
строка |
Не задан |
[In/Out] Имя политики (DLP) защита от потери данных, которая была применена к сообщению. Сведения о допустимых значений DlpPolicy Отчет о MailFilterListсм. |
Financial Data Detection, HIPAA Detection, PII Detection |
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 |
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/Out] Поле отчета, указанного в параметре $filter , с помощью этого поля определяет, как объединить записи отчета для формирования сводки. Если функция входит в параметре $select , это поле всегда возвращает null. Для получения дополнительных сведений в разделе «Замечания». |
Action, EventType, Domainи Direction являются единственными допускаются значения, которые могут использоваться в параметре $filter с этим полем. |
2013-V1 |
TransportRule |
строка |
Не задан |
Имя правила транспорта Microsoft Exchange выполнены на этапе обработки. Сведения о значениях допустимый TransportRuleОтчет о MailFilterListсм. |
PII Detection |
2013-V1 |
* Тип WCF относится к типу данных .NET Framework, назначенные в поле при создании Windows Communication Foundation (WCF) ссылки на службу в Visual Studio. Имя относится к модели данных ADO.NET сущности (EDM) типов, которые возвращаются в формате Atom отчеты.
** Сведения о [In/Out] индикаторов, см в разделе «Входные параметры и сообщить о выходных столбцов».
Замечания
Каждый элемент в отчете о включает несколько полей метаданных. Для получения дополнительных сведений см Распространенные метаданных, возвращаемых веб-службой отчетов Office 365.
Поле Date указывает, когда сообщения обрабатывались системой Office 365 и сообщает в часовом поясе из этих серверов.
С помощью StartDate и EndDate
Поля StartDate и EndDate не получать полезную информацию в отчет о результатах и всегда значение 0001-01-01T00:00:00Z в выходные данные отчета. Они предназначены для включить простой ограничение отчетов временной интервал, а также предоставлять большая точность не будет доступен в отчете «день».
Это может быть особенно полезны, например, при записи на основе электронной почты атак типа "отказ в обслуживании" на основе каждый час. При использовании этих полей, необходимо включить оба параметра $filter . Они оба считаются необязательные, но если один, которые необходимо указать другое. Если пара StartDate и EndDate не указан в запросе, отчетного периода времени по умолчанию — это предыдущие две недели. В разделе «Примеры» далее в этом разделе показано, как использовать поля StartDate и EndDate .
С помощью поля AggregateBy
Отчет о MailTrafficPolicy возвращает сводки событий, связанных сообщений электронной почты в системе Office 365. Каждое событие записывается с Action, Event, Date, Senderи т. д. Что записанных данных включает в себя точное дату и время каждого события. Отчеты «подробности», например MailDetailMalware, предоставить списки конкретными событиями и их точное время. «Трафика» отчеты, такие как MailTrafficPolicyсведение и может предоставить счетчика событий на двух длительности: час и дня. Какие длительности для использования в параметре $filter запроса укажите, как показано в следующем примере. Если нет сравнения AggregateBy входит в параметр $filter , используется по умолчанию Hour .
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?$filter=AggregateBy eq 'Day'
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?$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 пуст, так как операция приведена сводка по обоих Direction eq 'Inbound' сообщение, которое подсчитывает число и Direction eq ‘Outbound’ сообщения друг с другом.
Для использования с SummarizeByподдерживаются только следующие поля.
Action
EventType
Direction
Domain
Запросы могут включать несколько полей, разрешенных в целом, как и следующий параметр $filter .
$filter=SummarizeBy eq 'EventType,Action'
Если запрос использует SummarizeBy на поле, а также включает имя этого поля в параметре $select , поле всегда должны отображаться с пустым значением.
Следующий запрос показано, как запросить сводку день трафика электронной почты с только что Date, DirectionMessageCount поля и возвращаются. Результатом будет суммировать по дням. Разрывы были добавлены в запрос для наглядности.
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?
$select=Date,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/MailTrafficPolicy</id>
<title type="text">MailTrafficPolicy</title>
<entry>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
<d:Direction>Inbound</d:Direction>
<d:MessageCount m:type="Edm.Int32">7</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:Direction>Outbound</d:Direction>
<d:MessageCount m:type="Edm.Int32">58</d:MessageCount>
</m:properties>
</content>
</entry>
</feed>
Если же запроса с добавлением Подведение итогов с Direction, запрос становится следующее.
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?
$select=Date,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/MailTrafficPolicy</id>
<title type="text">MailTrafficPolicy</title>
<entry>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
<d:Direction>
</d:Direction>
<d:MessageCount m:type="Edm.Int32">65</d:MessageCount>
</m:properties>
</content>
</entry>
</feed>
Примеры
Приведенный ниже показано, как получить Сводка сообщений, входящих в организацию для 1 января 2013 г. в формате Atom XML. Для этого отчета использовалась SummarizeBy EventType , поэтому записи в один отчет для всех сообщений расположения выходных данных. Были добавлены символы перевода строки запроса и ответа и записи были удалены из ответа для наглядности.
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?
$select=Date,DlpPolicy,MessageCount,TransportRule&
$filter=Direction%20eq%20'Inbound'%20and%20
AggregateBy%20eq%20'Day'%20and%20
StartDate%20eq%20datetime'2013-01-01T00:00:00Z'%20and%20
EndDate%20eq%20datetime'2013-01-02T00:00:00Z'&$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/MailTrafficPolicy</id>
<title type="text">MailTrafficPolicy</title>
<updated>2013-02-09T15:25:28Z</updated>
<link rel="self" title="MailTrafficPolicy" href="MailTrafficPolicy" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(0)</id>
<category term="TenantReporting.MailTrafficPolicyReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(0)" />
<title />
<updated>2013-02-09T15:25:28Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
<d:DlpPolicy>
</d:DlpPolicy>
<d:TransportRule>PII Detection</d:TransportRule>
<d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(1)</id>
<category term="TenantReporting.MailTrafficPolicyReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(1)" />
<title />
<updated>2013-02-09T15:25:28Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
<d:DlpPolicy>
</d:DlpPolicy>
<d:TransportRule>PII Detection</d:TransportRule>
<d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(2)</id>
<category term="TenantReporting.MailTrafficPolicyReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(2)" />
<title />
<updated>2013-02-09T15:25:28Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
<d:DlpPolicy>PII Detection</d:DlpPolicy>
<d:TransportRule>PII Detection</d:TransportRule>
<d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(3)</id>
<category term="TenantReporting.MailTrafficPolicyReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(3)" />
<title />
<updated>2013-02-09T15:25:28Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
<d:DlpPolicy>PII Detection</d:DlpPolicy>
<d:TransportRule>PII Detection</d:TransportRule>
<d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(4)</id>
<category term="TenantReporting.MailTrafficPolicyReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(4)" />
<title />
<updated>2013-02-09T15:25:28Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
<d:DlpPolicy>PII Detection</d:DlpPolicy>
<d:TransportRule>PII Detection</d:TransportRule>
<d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
</m:properties>
</content>
</entry>
</feed>
Ниже представлены же отчетов результаты в формате JSON.
{
"d":
{
"results":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(0)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(0)",
"type":"TenantReporting.MailTrafficPolicyReport"
},
"Date":"\/Date(1356998400000)\/",
"DlpPolicy":"",
"TransportRule":"PII Detection",
"MessageCount":17
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(1)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(1)",
"type":"TenantReporting.MailTrafficPolicyReport"
},
"Date":"\/Date(1356998400000)\/",
"DlpPolicy":"",
"TransportRule":"PII Detection",
"MessageCount":17
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(2)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(2)",
"type":"TenantReporting.MailTrafficPolicyReport"
},
"Date":"\/Date(1356998400000)\/",
"DlpPolicy":"PII Detection",
"TransportRule":"PII Detection",
"MessageCount":17
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(3)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(3)",
"type":"TenantReporting.MailTrafficPolicyReport"
},
"Date":"\/Date(1356998400000)\/",
"DlpPolicy":"PII Detection",
"TransportRule":"PII Detection",
"MessageCount":17
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(4)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(4)",
"type":"TenantReporting.MailTrafficPolicyReport"
},
"Date":"\/Date(1356998400000)\/",
"DlpPolicy":"PII Detection",
"TransportRule":"PII Detection",
"MessageCount":17
}
]
}
}
Входные параметры и сообщить о выходных столбцов
[In/Out] индикаторов в таблице полей имеют следующие значения:
Поля, отмеченные [In] в таблице предназначены для использования в $filter=, $orderby=, поля и другие параметры запроса, ограничить вводимых данных в отчете. Поля, помеченные [In] в таблице поля могут быть включены в параметр $select= и они будут отображаться в отчет операции, но они будут не содержат полезных данных.
Поля, отмеченные [In/Out] в поля, которые в таблице можно использовать в выделенный фрагмент столбца ($select=) и параметры ($filter= и $orderby=) ограничение записей. При включении эти поля параметр $select= будет отображаться в отчет операции и будет содержать полезные данные, если она доступна.
Совместимость
Отчет о MailTrafficPolicy была введена в Служба Office 365 версии 2013-V1. Дополнительные сведения об управлении версиями содержатся в разделе Управление версиями в веб-службе отчетов Office 365.
Соответствующий командлетов Windows PowerShell
Отчет о MailDetailSpam возвращает те же данные в командлет Get-MailTrafficPolicyReportWindows PowerShell.
Разрешения
Учетная запись, используемая для доступа к отчетам необходимо иметь права администратора в организации Office 365. Если учетная запись может просмотреть этот отчет в Office 365 панель управления, учетная запись имеет разрешения для извлечения данных из веб-службы REST. В этом отчете требует от пользователя быть назначена роль получателей только для просмотра. В структуре разрешения по умолчанию Office 365 пользователей со следующими разрешениями администратора может вызвать этот отчет: выставления счетов администратора, глобального администратора, пароль администратора, администратора служб и администратор управления пользователями.
Степень детализации данных, сохранение состояния и доступности
Сведения о доступных в данном отчете хранятся с точным даты и времени для каждого события. Можно использовать любой период реального времени и длительность, включая поля StartDate и EndDate в параметре $filter . Время отображается в часовом поясе сервера сканирования сообщение электронной почты. В этом отчете вычисляет подсчитывает сообщения через дни или часы, в зависимости от того, в поле AggregateBy .
Сведения для этого отчета можно найти в течение 14 дней или до отмены подписки.
События с задержкой в течение 24 часов, прежде чем они отображаются в отчете.