Relatório de MailTrafficTop

Artigo
11/14/2016

O URI do REST MailTrafficTop fornece informações de resumo sobre os usuários enviando e recebendo o maior número de mensagens de email na organização. A data de início e término/hora do relatório pode ser especificada na solicitação, assim como o período de tempo para o qual os dados são agregados.

Última alteração: quinta-feira, 17 de setembro de 2015

Aplica-se a: Office 365

URIs REST

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

Campos

Os campos a seguir podem ser especificados em Opções de consulta ODATA2 $select, $filtere $orderby . Todos os campos são retornados se nenhuma opção $select for fornecida.

Nome	Tipo WCF *	Tipo EDM *	[Em/fora] * * descrição	Valores de exemplo	Adicionado ao serviço versão
AggregateBy	Cadeia de caracteres	Nenhum especificado	[In] Indica se combinar dados em entradas de relatório que abrangem o dia inteiro. Os valores somente $filter permitidos são Day e Hour. Quando não fornecido, o relatório agrega por períodos de 1 hora. Quando incluído em uma opção de $select , esse campo sempre retorna null. Consulte a seção "Comentários" para obter mais informações.	Day ou Hour	2013-V1
Date	System.DateTime	Edm.DateTime	[/ Saída] A data e hora que a mensagem foi detectada como spam.	Data curta (por exemplo, 03/10/2013) ou Data hora com aspas (por exemplo, "03/10/2013 4:55 PM")	2013-V1
Direction	Cadeia de caracteres	Nenhum especificado	[/ Saída] Especifica se o email estava sendo enviado para (Inbound) ou (Outbound) da organização, quando ele foi detectado como sendo de spam.	Os valores são restritos Inbound e Outbound	2013-V1
Domain	Cadeia de caracteres	Nenhum especificado	[/ Saída] O nome de domínio totalmente qualificado que estava processando o email.	example.onmicrosoft.com	2013-V1
EndDate	System.DateTime	Edm.DateTime	[In] Este campo é usado para limitar o período do relatório. Use este campo em uma opção de consulta $filter para definir a data de término e a hora do período do relatório. Se você fornecer EndDate na opção $filter , você também deverá fornecer StartDate.	Data curta (por exemplo, 03/10/2013) ou Data hora com aspas (por exemplo, "03/10/2013 4:55 PM")	2013-V1
EventType	Cadeia de caracteres	Nenhum especificado	[/ Saída] O tipo de verificação de evento registrada. Para obter informações sobre os valores válidos EventType , consulte Relatório de MailFilterList.	SpamContentFiltered, SpamIPBlock	2013-V1
MessageCount	int	Edm.Int64	[/ Saída] O número de mensagens que se ajustam as categorias indicadas por outros campos, durante o período de agregação.	1254	2013-V1
Name	Cadeia de caracteres	Nenhum especificado	O endereço de email SMTP do usuário associado com as mensagens resumidas na entrada do relatório.	userone@example.com	2013-V1
Organization	Cadeia de caracteres	Nenhum especificado	[/ Saída] O nome de domínio totalmente qualificado que estava processando o email.	example.onmicrosoft.com	2013-V1
StartDate	System.DateTime	Edm.DateTime	[In] Este campo é usado para limitar o período do relatório. Use este campo em uma opção de consulta $filter para definir a data de início e a hora do período do relatório. Se você fornecer um StartDate na opção $filter , você também deve especificar um EndDate.	Data curta (por exemplo, 03/10/2013) ou Data hora com aspas (por exemplo, "03/10/2013 4:55 PM")	2013-V1
SummarizeBy	Cadeia de caracteres	Nenhum especificado	[In] O campo de relatório especificado na opção $filter usando esse campo determina como as entradas de relatório são combinadas para formar um resumo. Consulte a seção "Comentários" para obter mais informações. Quando incluído em uma opção de $select , esse campo sempre retorna null.	Action, EventType, Domaine Direction são os únicos valores que podem ser usados em uma opção $filter com este campo permitidos	2013-V1

* O Tipo de WCF refere-se ao tipo de dados .NET Framework atribuído ao campo quando você cria um Windows Communication Foundation (WCF) referência de serviço no Visual Studio. O Tipo de EDM refere-se para os tipos de modelo de dados de entidade ADO.NET (EDM) retornados nos relatórios Atom formatada.

* * Para obter informações sobre [/ saída] indicadores, consulte a seção "Parâmetros de entrada e relatar as colunas de saída".

Comentários

Cada entrada no relatório inclui vários campos de metadados. Para obter mais informações, consulte Metadados comum retornados pelo serviço web de relatório do Office 365.

O campo Date indica quando as mensagens foram tratadas pelo sistema Office 365 e informadas no fuso horário desses servidores.

A opção de $orderby ODATA não funciona com este relatório.

Usando StartDate e EndDate

Os campos StartDate e EndDate não fornecem informações úteis nos resultados do relatório e sempre estão definidos para 0001-01-01T00:00:00Z na saída do relatório. Eles servem para habilitar fácil restrição da janela de tempo de relatórios e fornecer mais fina precisão de seria disponíveis em um relatório "diariamente".

Isso pode ser especialmente útil, por exemplo, quando a gravação de ataques de negação de serviço baseados em email em uma base por hora. Ao usar esses campos, você deve incluir ambos na opção $filter . Eles são considerados opcionais, mas se você fornecer um, você precisa fornecer o outro. Se o par StartDate/EndDate não forem fornecido na consulta, o padrão de período de relatório é as duas semanas anteriores. A seção "Exemplos" posteriormente neste tópico mostra como usar os campos StartDate e EndDate .

Usando o campo AggregateBy

O relatório de MailTrafficTop retorna resumos dos usuários contagem mais alto de mensagens do sistema Office 365. Cada evento é registrado com um Action, Event, Date, Sendere assim por diante. Os dados gravados pelo Office 365 incluem a data e hora exatas de cada evento. O "Detalhes" relata como MailDetailMalware fornecem listas de eventos específicos e seus horários exatos. Os relatórios "do tráfego", como MailTrafficTop, resumir e pode fornecer contagens desses eventos em duas durações: dia e hora. Você especificar qual duração para usar a opção de consulta $filter , conforme mostrado no exemplo a seguir. Se nenhuma comparação AggregateBy está incluída na opção $filter , o padrão Hour será usado.

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'

Usando o campo SummarizeBy

O campo SummarizeBy permite "recolher" a saída de relatório em um nome de campo especificado. Por exemplo, vamos supor que houve 200 emails de saída de entrada e 100 durante um período do relatório de dia inteiro único. Se sua consulta inclui $filter=AggregateBy eq ‘Day’, o relatório retornaria duas entradas separadas daquele dia: uma para emails de entrada mostrando uma MessageCount de 200 e um Direction de Inbounde outra entrada de emails de saída mostrando uma MessageCount de 100 e um Direction de Outbound. Se você fornecer também o campo SummarizeBy na opção $filter , como SummarizeBy eq ‘Direction’, o relatório incluiria, em seguida, apenas uma entrada daquele dia, com um campo vazio Direction e um MessageCount de 300. O campo direção está vazio, pois a entrada resume ambas mensagem Direction eq ‘Inbound’ contagens de mensagem contagens e Direction eq ‘Outbound’ juntos.

Somente os campos a seguir são suportados para uso com SummarizeBy.

Action
EventType
Direction
Domain

Suas solicitações podem incluir mais de um dos campos permitidos para resumir, como a seguinte opção $filter .

$filter=SummarizeBy eq 'EventType,Action'

Se a solicitação usa SummarizeBy em um campo e também inclui esse nome de campo na opção $select , o campo sempre será relatado com um valor vazio.

A solicitação a seguir mostra como solicitar o resumo diário de usuários de email superior, com apenas os Name, Date, Directione MessageCount campos retornados. Os resultados devem ser agregados por dia. Quebras de linha foram adicionadas à solicitação para manter a clareza.

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

O exemplo a seguir mostra os resultados da solicitação. Para simplificar os resultados, a maioria dos elementos de metadados foram removida. Observação lá são duas entradas, um com Direction de Inbounde o outro para o mesmo dia com um 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/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>

Se você fizer a solicitação mesma com a adição de resumindo por Direction, a solicitação se torna a seguir.

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

A resposta para esse mesmo dia recolhe ou resume o campo Direction . Em outras palavras, ele combina as contagens de todas as entradas que diferem somente em seu valor do campo Direction . O elemento Direction é retornado como vazia, indicando que a entrada de relatório combina contagens de eventos, ignorando as diferenças nos 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/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>

Exemplos

O exemplo a seguir mostra como recuperar informações sobre as contas de usuário de três principais que recebeu a maioria das email em 6 de fevereiro de 2013, no formato Atom. Quebras de linha foram adicionadas para a solicitação e a resposta para manter a clareza.

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>

A seguir mostra os mesmos resultados de relatórios no formato 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
          }
      ]
  }

Parâmetros de entrada e relatar colunas de saída

Os indicadores de [/ saída] na tabela campos têm os significados a seguintes:

Campos marcados [In] nos campos de tabela destinam-se principalmente para uso em $filter=, $orderby=, e outras opções de consulta que restringir quais entradas retorna o relatório. Campos marcados [In] na tabela campos podem ser incluídos na opção $select= e eles serão exibidos nas entradas de relatório, mas que não irão conter nenhum dado útil.
Campos marcados [/ saída] nos campos de tabela pode ser usada nas opções de ($filter= e $orderby=) da restrição de entrada e seleção de coluna ($select=). Quando você inclui um desses campos na opção $select= , ele aparecerá nas entradas de relatório e irá conter dados úteis quando ele estiver disponível.

Compatibilidade

O relatório de MailTrafficTop foi introduzido no Office 365 service version 2013-V1. Para obter mais informações sobre o controle de versão, consulte Controle de versão no serviço da web de relatório do Office 365.

Cmdlets do Windows PowerShell correspondentes

O relatório de MailTrafficTop retorna as mesmas informações que o cmdlet Get-MailTrafficTopReportWindows PowerShell.

Permissões

A conta usada para acessar os relatórios deve ter permissões administrativas na organização Office 365. Se a conta pode exibir este relatório no Office 365 painel de controle, a conta tem permissões para recuperar os dados do serviço web REST. Este relatório requer que o usuário a ser atribuído à função destinatários somente para exibição. Na estrutura de permissões de Office 365 padrão, os usuários com as seguintes permissões de administrador podem acessar este relatório: administrador de gerenciamento de usuário, administrador global, administrador de senha, administrador de serviço e administrador de faturamento.

Disponibilidade, persistência e granularidade de dados

Informações disponíveis neste relatório serão armazenadas com a data e hora exatas para cada evento. Você pode usar qualquer período viável e a duração, incluindo os campos StartDate e EndDate na opção $filter . Tempos são relatados no fuso horário do servidor de email de verificação. Este relatório calcula contagens de mensagem sobre horas ou dias, dependendo do campo AggregateBy .

As informações para esse relatório estão disponíveis por um período de 14 dias ou até que a assinatura será cancelada.

Eventos podem ser atrasados por até 24 horas antes que eles aparecem em um relatório.