Informe de MailTraffic

Artículo
11/14/2016

El URI de REST de MailTraffic proporciona información resumida sobre el tráfico hacia y desde la organización de correo. El inicio y fin fecha y hora del informe pueden especificarse en la solicitud, como el período de tiempo para la que se agregan los datos.

Última modificación: jueves, 17 de septiembre de 2015

Hace referencia a: Office 365

URI de REST

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic[?ODATA options]

Campos

Los siguientes campos pueden especificarse en las opciones de consulta de ODATA2 $select, $filtery $orderby . Si no hay ninguna opción de $select se proporciona, se devuelven todos los campos.

Nombre	Tipo WCF *	Tipo EDM *	[In/Out] ** descripción	Valores de ejemplo	Agregado en la versión de servicio
Action	string	No se especifica ninguno	[In/Out] Descripción de la acción realizada en el mensaje, si lo hay. Este campo puede estar en blanco o null si no se llevó a cabo ninguna acción. Para obtener información sobre los valores válidos de acción, consulte Informe de MailFilterList.	SetSpamConfidenceLevel, RejectMessage	2013-V1
AggregateBy	string	No se especifica ninguno	[Entrada] Indica si se va a combinar datos en las entradas de informe que abarquen días completos. Los valores de sólo $filter permitidos son Day y Hour. Cuando no se proporciona, el informe se agrega durante períodos de 1 hora. Cuando se incluye en una opción de $select , este campo siempre devuelve null. Vea la sección "Comentarios" para obtener más información.	Day o Hour	2013-V1
Date	System.DateTime	Edm.DateTime	[In/Out] Fecha y hora que se detectó el mensaje como spam.	Fecha corta (por ejemplo, 03/10/2013) o Fecha hora con comillas (por ejemplo, "03/10/2013 4:55 PM")	2013-V1
Direction	string	No se especifica ninguno	[In/Out] Especifica si el correo se ha enviado en (Inbound) o fuera de (Outbound) la organización al que se detectó como spam.	Los valores están restringidos a Inbound y Outbound.	2013-V1
Domain	string	No se ha especificado	[In/Out] El nombre de dominio completo que se procesa el correo electrónico.	example.onmicrosoft.com	2013-V1
EndDate	System.DateTime	Edm.DateTime	[Entrada] Este campo se usa para limitar el período del informe. Use este campo en una opción de consulta de $filter para establecer la fecha y hora finales del período de notificación. Si proporciona EndDate en la opción $filter , también debe proporcionar StartDate.	Fecha corta (por ejemplo, 03/10/2013) o Fecha hora con comillas (por ejemplo, "03/10/2013 4:55 PM")	2013-V1
EventType	string	No se especifica ninguno	[In/Out] El tipo de evento registrado el examen. Para obtener información acerca de los valores válidos EventType , vea Informe de MailFilterList.	SpamContentFiltered, SpamIPBlock	2013-V1
MessageCount	int	Edm.Int64	[In/Out] El número de mensajes que se ajusten a las categorías que se indican mediante los demás campos, durante el período de adición.	1254	2013-V1
Organization	string	No se especifica ninguno	[In/Out] El nombre de dominio completo que se procesa el correo electrónico.	example.onmicrosoft.com	2013-V1
StartDate	System.DateTime	Edm.DateTime	[Entrada] Este campo se usa para limitar el período del informe. Use este campo en una opción de consulta de $filter para establecer la fecha de inicio y la hora del período de notificación. Si proporciona un StartDate en la opción $filter , también debe especificar un EndDate.	Fecha corta (por ejemplo, 03/10/2013) o Fecha hora con comillas (por ejemplo, "03/10/2013 4:55 PM")	2013-V1
SummarizeBy	string	No se especifica ninguno	[Entrada] El campo de informe especificado en la opción de $filter mediante este campo determina cómo se combinan las entradas de informe para formar un resumen. Vea la sección "Comentarios" para obtener más información. Cuando se incluye en una opción de $select , este campo siempre devuelve null.	Action, EventType, Domainy Direction son los únicos valores que se pueden usar en una opción de $filter con este campo permitidos.	2013-V1

* El Tipo de WCF hace referencia al tipo de datos .NET Framework asignado al campo cuando se crea una referencia de servicio Windows Communication Foundation (WCF) en Visual Studio. El Tipo de EDM hace referencia a los tipos de ADO.NET Entity Data Model (EDM) devueltos en los informes con formato Atom.

** Para obtener información acerca de los indicadores de [In/Out], vea la sección "Columnas de resultados de informes y los parámetros de entrada".

Comentarios

Cada entrada en el informe incluye varios campos de metadatos. Para obtener más información, vea Metadatos comunes devueltos por el servicio web de informes de Office 365.

El campo Date indica si los mensajes fueron administrados por el sistema Office 365 y se indican en la zona horaria de esos servidores.

Uso de StartDate y EndDate

Los campos StartDate y EndDate no proporcionan información útil en los resultados del informe y siempre se establecen en 0001-01-01T00:00:00Z en la salida del informe. Están pensadas para habilitar fácil de restricción de la ventana de tiempo de generación de informes y a continuación, proporcione un mayor precisión que estaría disponible en un informe "diario".

Esto puede ser especialmente útil, por ejemplo, al grabar basada en correo electrónico ataques de denegación de servicio en cada hora. Al usar estos campos, debe incluir en la opción $filter . Se consideran opcionales, pero si se proporciona una, debe proporcionar a la otra. Si el par StartDate y EndDate no se proporciona en la consulta, el informe de un período de tiempo predeterminado es las dos semanas anteriores. La sección "Ejemplos" más adelante en este tema muestra cómo usar los campos StartDate y EndDate .

Utilizando el campo AggregateBy

El informe de MailTraffic devuelve los resúmenes de eventos asociada al correo electrónico en el sistema de Office 365. Cada evento se registra con su Action, Event, Date, Sendery así sucesivamente. Los datos registrados por Office 365 incluyen la fecha exacta y la hora de cada evento. Los informes de "Detalles", como MailDetailMalware, proporcionan listas de eventos específicos y sus períodos exactas. Los informes de "tráfico", como MailTraffic, resumir y puede proporcionar recuentos de los eventos en dos duraciones: hora y día. Especifique qué duración para usar en la opción de consulta $filter , tal como se muestra en el ejemplo siguiente. Si ninguna comparación AggregateBy se incluye en la opción $filter , se usa el valor predeterminado Hour .

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic?$filter=AggregateBy eq 'Day'

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic?$filter=AggregateBy eq 'Hour'

Utilizando el campo SummarizeBy

El campo SummarizeBy permite la salida del informe "collapse" en un nombre de campo especificado. Por ejemplo, supongamos que había correos salientes entrantes y 100 200 durante un único período informes de día de duración. Si su consulta incluye $filter=AggregateBy eq ‘Day’, el informe devolvería dos entradas independientes para ese día: uno para los mensajes entrantes que muestra un MessageCount de 200 y un Direction de Inboundy otra entrada para los correos salientes que muestra un MessageCount de 100 y un Direction de Outbound. Si también proporcionan el campo SummarizeBy en la opción $filter , como en SummarizeBy eq ‘Direction’, el informe incluiría, a continuación, sólo una entrada para ese día, con un campo vacío Direction y un MessageCount de 300. El campo Direction está vacío, debido a que la entrada resume ambos mensaje Direction eq ‘Inbound’ conjuntamente los recuentos de mensajes recuentos y Direction eq ‘Outbound’ .

Sólo los siguientes campos son compatibles para su uso con SummarizeBy.

Action
EventType
Direction
Domain

Las solicitudes de pueden incluir más de uno de los campos permitidos para resumir, como se muestra en la siguiente opción de $filter .

$filter=SummarizeBy eq 'EventType,Action'

Si la solicitud de SummarizeBy usa en un campo y también incluye el nombre de ese campo en la opción $select , siempre se registrará el campo con un valor vacío.

La solicitud siguiente muestra cómo solicitar el resumen diario del tráfico de correo electrónico, con solo los campos Date, Directiony MessageCount devueltos. Los resultados se van a agregarse por día. Saltos de línea se agregaron a la solicitud para mayor claridad.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic?
$select=Date,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'&
$format=Atom

A continuación muestra los resultados de la solicitud. Para simplificar los resultados, se han quitado la mayoría de los elementos de metadatos. Tenga en cuenta que no hay dos entradas, uno con Direction de Inboundy el otro para el mismo día con un Direction de 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/MailTraffic</id>
  <title type="text">MailTraffic</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>

Si realiza la misma solicitud con la incorporación de resumir por Direction, la solicitud se convierte en el siguiente.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic?
$select=Date,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'%20and%20SummarizeBy%20eq%20'Direction'&
$format=Atom

La respuesta de ese mismo día, a continuación, se contrae o Resume, el campo Direction . En otras palabras, combina los recuentos de todas las entradas que sólo se diferencian en su valor de campo de Direction . El elemento Direction se devuelve como vacía, que indica que la entrada del informe combina recuentos de eventos, se omitirá las diferencias entre los valores de 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/MailTraffic</id>
  <title type="text">MailTraffic</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>

Ejemplos

En el ejemplo siguiente se muestra cómo recuperar un resumen de diario los mensajes de entrada a la organización para la primera semana de enero de 2013, en formato basado en XML de Atom. Para este informe, se usó SummarizeBy EventType , por lo que el resultado es una entrada de informe único para todas las disposiciones de mensaje. Saltos de línea se agregaron a la solicitud y la respuesta para mayor claridad.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic?
$select=MessageCount,%20Date&
$filter=Direction%20eq%20'Inbound'%20and%20AggregateBy%20eq%20'Day'%20and%20
  StartDate%20eq%20datetime'2013-01-01T00:00:00Z'%20and%20
  EndDate%20eq%20datetime'2013-01-08T00:00:00Z'%20and%20
  SummarizeBy%20eq%20'EventType'&
$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/MailTraffic</id>
  <title type="text">MailTraffic</title>
  <updated>2013-02-09T02:02:16Z</updated>
  <link rel="self" title="MailTraffic" href="MailTraffic" />
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(0)</id>
    <category term="TenantReporting.MailTrafficReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficReport" href="MailTraffic(0)" />
    <title />
    <updated>2013-02-09T02:02:16Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
        <d:MessageCount m:type="Edm.Int32">100</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(1)</id>
    <category term="TenantReporting.MailTrafficReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficReport" href="MailTraffic(1)" />
    <title />
    <updated>2013-02-09T02:02:16Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-02T00:00:00</d:Date>
        <d:MessageCount m:type="Edm.Int32">150</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(2)</id>
    <category term="TenantReporting.MailTrafficReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficReport" href="MailTraffic(2)" />
    <title />
    <updated>2013-02-09T02:02:16Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-03T00:00:00</d:Date>
        <d:MessageCount m:type="Edm.Int32">158</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(3)</id>
    <category term="TenantReporting.MailTrafficReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficReport" href="MailTraffic(3)" />
    <title />
    <updated>2013-02-09T02:02:16Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-04T00:00:00</d:Date>
        <d:MessageCount m:type="Edm.Int32">178</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(4)</id>
    <category term="TenantReporting.MailTrafficReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficReport" href="MailTraffic(4)" />
    <title />
    <updated>2013-02-09T02:02:16Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-05T00:00:00</d:Date>
        <d:MessageCount m:type="Edm.Int32">116</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(5)</id>
    <category term="TenantReporting.MailTrafficReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficReport" href="MailTraffic(5)" />
    <title />
    <updated>2013-02-09T02:02:16Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-06T00:00:00</d:Date>
        <d:MessageCount m:type="Edm.Int32">108</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(5)</id>
    <category term="TenantReporting.MailTrafficReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficReport" href="MailTraffic(5)" />
    <title />
    <updated>2013-02-09T02:02:16Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-07T00:00:00</d:Date>
        <d:MessageCount m:type="Edm.Int32">45</d:MessageCount>
      </m:properties>
    </content>
  </entry>
</feed>

A continuación muestra los mismos resultados informes en formato JSON.

  {
    "d":
      {
        "results":
          [
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(0)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(0)",
                    "type":"TenantReporting.MailTrafficReport"
                  },
                "Date":"\/Date(1356998400000)\/",
                "MessageCount":100
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(1)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(1)",
                    "type":"TenantReporting.MailTrafficReport"
                  },
                "Date":"\/Date(1357084800000)\/",
                "MessageCount":150
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(2)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(2)",
                    "type":"TenantReporting.MailTrafficReport"
                  },
                "Date":"\/Date(1357171200000)\/",
                "MessageCount":158
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(3)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(3)",
                    "type":"TenantReporting.MailTrafficReport"
                  },
                "Date":"\/Date(1357257600000)\/",
                "MessageCount":178
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(4)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(4)",
                    "type":"TenantReporting.MailTrafficReport"
                  },
                "Date":"\/Date(1357344000000)\/",
                "MessageCount":116
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(5)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(5)",
                    "type":"TenantReporting.MailTrafficReport"
                  },
                "Date":"\/Date(1357430400000)\/",
                "MessageCount":108
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(6)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTraffic(6)",
                    "type":"TenantReporting.MailTrafficReport"
                  },
                "Date":"\/Date(135751680000)\/",
                "MessageCount":45
              }
          ]
      }
  }

Parámetros de entrada y salida columnas de informe

Los indicadores de [In/Out] en la tabla campos tienen los significados siguientes:

Campos marcados [In] en los campos de tabla principalmente están diseñados para su uso en $filter=, $orderby=, y otras opciones de consulta que restringir las entradas que se devuelve el informe. Los campos marcados [In] en la tabla campos pueden incluirse en la opción $select= y aparecen en las entradas de informe, pero no va a contener ningún dato útil.
En los campos de tabla puede utilizarse en la selección de columna ($select=) y la restricción ($filter= y $orderby=) opciones de entrada de los campos marcados [In/Out]. Cuando uno de estos campos se incluye en la opción $select= , aparecerán en las entradas de informe y va a contener datos útiles cuando esté disponible.

Compatibilidad

El informe de MailTraffic se introdujo en Versión 2013-V1 del servicio de Office 365. Para obtener más información sobre el control de versiones, vea Control de versiones en el servicio web de informes de Office 365.

Cmdlets de Windows PowerShell correspondientes

El informe de MailTraffic devuelve la misma información que el cmdlet de Get-MailTrafficReportWindows PowerShell.

Permisos

La cuenta que use para tener acceso a los informes debe tener permisos administrativos en la organización de Office 365. Si la cuenta puede ver este informe en el Panel de Control Office 365, la cuenta tiene permisos para recuperar los datos desde el servicio web REST. Este informe requiere que el usuario que se asignará a la función de los destinatarios con permiso de vista. En la estructura de permisos Office 365 de forma predeterminada, los usuarios con los siguientes permisos de administrador pueden tener acceso a este informe: administrador del usuario, administrador global, Administrador de contraseñas, Administrador de servicio y Administrador de facturación. Para obtener más información, vea Informe de uso del buzón de correo:.

Disponibilidad, la persistencia y la granularidad de datos

Información disponible en este informe se almacena con la fecha exacta y la hora para cada evento. Puede usar cualquier período de tiempo viable y la duración mediante la inclusión de los campos StartDate y EndDate en la opción $filter . Veces se indican en la zona horaria del servidor de análisis del correo electrónico. Este informe se calcula las estadísticas de mensaje en horas o días, dependiendo del campo AggregateBy .

La información de este informe está disponible durante un período de 14 días, o hasta que se cancele la suscripción.

Los eventos se pueden retrasar por 24 horas antes de que aparezcan en un informe.

Compartir a través de