Rapport de MailTraffic
L'URI REST MailTraffic fournit des informations récapitulatives concernant le trafic des messages vers et depuis l'organisation. Start et end date/heure du rapport peut être spécifiée dans la demande, que vous pouvez la période pour laquelle les données sont agrégées.
Dernière modification : jeudi 17 septembre 2015
S’applique à : Office 365
URI REST
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic[?ODATA options]
Champs
Les champs suivants peuvent être spécifiées dans les options de requête de ODATA2 $select, $filteret $orderby . Tous les champs sont renvoyés si aucune option $select n'est fournie.
Nom |
WCF Type * |
Type EDM * |
[In/Out] ** Description |
Exemples de valeurs |
Ajouté dans la version de service |
---|---|---|---|---|---|
Action |
string |
Aucun n'est spécifié |
[In/Out] Description de l'action effectuée sur le message, le cas échéant. Ce champ peut être vide ou null si aucune action n'a été effectuée. Pour plus d'informations sur les valeurs d'Action valides, reportez-vous à la section Rapport de MailFilterList. |
SetSpamConfidenceLevel, RejectMessage |
2013-V1 |
AggregateBy |
string |
Aucun n'est spécifié |
[In] Indique s'il faut combiner des données dans les entrées de rapport portant sur des jours entiers. Seul $filter valeurs autorisées sont Day et Hour. N'est ne pas fourni, le rapport regroupant sur des périodes de 1 heure. Lorsque inclus dans une option de $select , ce champ retourne toujours null. Voir la section « Remarques » pour plus d'informations. |
Day ou Hour |
2013-V1 |
Date |
System.DateTime |
Edm.DateTime |
[In/Out] La date et l'heure que du message a été détecté comme étant du courrier indésirable. |
Date, abrégé (par exemple, 03/10/2013) ou l' Heure avec les guillemets (par exemple, "03/10/2013 4:55 PM") |
2013-V1 |
Direction |
string |
Aucun n'est spécifié |
[In/Out] Spécifie si le message a été envoyé dans (Inbound) ou à partir de (Outbound) l'organisation lorsqu'il a été détecté comme étant du courrier indésirable. |
Les valeurs sont limitées à Inbound et Outbound. |
2013-V1 |
Domain |
string |
Non spécifié |
[In/Out] Le nom de domaine complet qui a été de traitement du message électronique. |
example.onmicrosoft.com |
2013-V1 |
EndDate |
System.DateTime |
Edm.DateTime |
[In] Ce champ est utilisé pour limiter la période du rapport. Utilisez ce champ dans une option de requête $filter pour définir la date de fin et l'heure de la période de rapport. Si vous fournissez EndDate dans l'option $filter , vous devez également fournir StartDate. |
Date, abrégé (par exemple, 03/10/2013) ou l' Heure avec les guillemets (par exemple, "03/10/2013 4:55 PM") |
2013-V1 |
EventType |
string |
Aucun n'est spécifié |
[In/Out] Le type d'événement ouvert une session d'analyse. Pour plus d'informations sur les valeurs valides EventType , consultez la rubrique Rapport de MailFilterList. |
SpamContentFiltered, SpamIPBlock |
2013-V1 |
MessageCount |
int |
Edm.Int64 |
[In/Out] Le nombre de messages qui tiennent les catégories indiquées par les autres champs, pendant la période de groupement. |
1254 |
2013-V1 |
Organization |
string |
Aucun n'est spécifié |
[In/Out] Le nom de domaine complet qui a été de traitement du message électronique. |
example.onmicrosoft.com |
2013-V1 |
StartDate |
System.DateTime |
Edm.DateTime |
[In] Ce champ est utilisé pour limiter la période du rapport. Utilisez ce champ dans une option de requête $filter pour définir la date de début et l'heure de la période de rapport. Si vous fournissez un StartDate dans l'option $filter , vous devez également spécifier un EndDate. |
Date, abrégé (par exemple, 03/10/2013) ou l' Heure avec les guillemets (par exemple, "03/10/2013 4:55 PM") |
2013-V1 |
SummarizeBy |
string |
Aucun n'est spécifié |
[In] Le champ d'état spécifié dans l'option $filter à l'aide de ce champ détermine la façon dont les entrées de rapport sont combinées pour former un résumé. Voir la section « Remarques » pour plus d'informations. Lorsque inclus dans une option de $select , ce champ retourne toujours null. |
Action, EventType, Domainet Direction sont les seuls autorisés les valeurs qui peuvent être utilisées dans une option $filter avec ce champ. |
2013-V1 |
* Le Type de WCF fait référence au type de données .NET Framework affecté au champ lorsque vous créez un Windows Communication Foundation (WCF) une référence de Service dans Visual Studio. Le Type EDM fait référence aux types ADO.NET Entity Data Model (EDM) renvoyées dans les rapports au format Atom.
** Pour plus d'informations sur les indicateurs [In/Out], consultez la section « Paramètres d'entrée et les colonnes de sortie de rapport ».
Remarques
Chaque entrée dans le rapport comprend plusieurs champs de métadonnées. Pour plus d'informations, voir Les métadonnées renvoyées par le service web de création de rapports Office 365.
Le champ Date indique lorsque les messages ont été traitées par le système Office 365 et sont déclarées dans le fuseau horaire de ces serveurs.
À l'aide de StartDate et EndDate
Les champs StartDate et EndDate ne fournissent pas d'informations utiles dans les résultats du rapport et sont toujours la valeur 0001-01-01T00:00:00Z dans la sortie du rapport. Ils sont destinés à activer la restriction facile de la fenêtre de temps de création de rapports et fournir une plus fine précision que seraient disponibles dans un état « quotidien ».
Cela peut être particulièrement utile, par exemple, lors de l'enregistrement des attaques par déni de service courrier toutes les heures. Lorsque vous utilisez ces champs, vous devez inclure à la fois l'option $filter . Ils sont considérées comme étant facultatifs, mais si vous fournissez une, vous devez fournir l'autre. Si la paire StartDate/EndDate n'est pas disponibles dans la requête, la période de création de rapports par défaut est deux semaines précédentes. La section « Exemples » plus loin dans cette rubrique montre comment utiliser les champs StartDate et EndDate .
En utilisant le champ AggregateBy
Le rapport MailTraffic renvoie les résumés des événements liés à la messagerie dans le système Office 365. Chaque événement est consignée avec ses ActionEvent, Date, Senderet ainsi de suite. Les données enregistrées par Office 365 incluent la date exacte et l'heure de chaque événement. Les rapports de « détail », par exemple MailDetailMalware, fournissent des listes d'événements spécifiques et leurs périodes exactes. Les rapports « le trafic », par exemple MailTraffic, résumer et peut fournir le nombre de ces événements sur deux durées : heures et jours. Vous spécifiez quelle durée à utiliser dans l'option de requête $filter , comme illustré dans l'exemple suivant. Si aucune comparaison AggregateBy n'est inclus dans l'option $filter , la valeur par défaut Hour est utilisée.
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'
En utilisant le champ SummarizeBy
Le champ SummarizeBy vous permet de "réduire" la sortie du rapport sur un nom de champ spécifié. Supposons, par exemple, il y avait 200 messages sortants entrants » et « 100 pendant une période de rapport journée unique. Si votre requête porte sur $filter=AggregateBy eq ‘Day’, le rapport retournerait deux entrées distinctes pour le jour : un pour les messages entrants affichant une MessageCount de 200 et un Direction de Inboundet une autre entrée pour les messages électroniques sortants affichant une MessageCount de 100 et un Direction de Outbound. Si vous fournissez également le champ SummarizeBy dans l'option $filter , comme dans SummarizeBy eq ‘Direction’, le rapport contiendra qu'une seule entrée pour le jour, avec un champ vide Direction et un MessageCount de 300. Le champ Direction est vide, car l'entrée récapitule les deux messages Direction eq ‘Inbound’ nombre de messages des nombres et Direction eq ‘Outbound’ entre eux.
Seuls les champs suivants sont pris en charge pour une utilisation avec SummarizeBy.
Action
EventType
Direction
Domain
Vos demandes peuvent inclure plusieurs champs autorisés pour résumer, comme dans l'option $filter suivante.
$filter=SummarizeBy eq 'EventType,Action'
Si la demande utilise SummarizeBy sur un champ et inclut également ce nom de champ dans l'option $select , le champ est toujours signalé avec une valeur vide.
La requête suivante montre comment demander le résumé quotidien du trafic de messagerie, avec seulement les champs Date, Directionet MessageCount renvoyés. Les résultats doivent être regroupés par jour. Sauts de ligne ont été ajoutés à la demande pour plus de clarté.
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic?
$select=Date,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'&
$format=Atom
Voici les résultats de la demande. Pour simplifier les résultats, la plupart des éléments de métadonnées ont été supprimée. Notez qu'il existe deux entrées, l'autre avec Direction de Inboundet l'autre pour le même jour avec 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 vous effectuez la demande de même avec l'ajout de synthèse par Direction, la demande devient suivantes.
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 réponse pour le même jour puis réduit ou résume, le champ Direction . En d'autres termes, elle combine les nombres pour toutes les entrées qui diffèrent uniquement par leur valeur du champ Direction . L'élément Direction est retourné en tant qu'est vide, indiquant que l'entrée du rapport combine le nombre d'événements, en ignorant les différences dans les valeurs 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>
Exemples
L'exemple suivant montre comment récupérer un résumé de tous les jours les messages entrant vers l'organisation pour la première semaine de janvier 2013, au format Atom XML. Pour ce rapport, SummarizeBy EventType a été utilisé, le résultat est une entrée de rapport unique pour tous les problèmes de message. Sauts de ligne ont été ajoutés à la demande et la réponse pour plus de clarté.
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>
Voici les mêmes résultats de création de rapports au format 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
}
]
}
}
Paramètres d'entrée et de colonnes de sortie de l'état
Les indicateurs [In/Out] dans la table champs ont les significations suivantes :
Les champs marqués [In] dans les champs de table sont principalement destinés à être utilisés dans $filter=, $orderby=, et autres options de requête qui restreignent les entrées renvoie le rapport. Champs marqués [In] dans la table champs peuvent être inclus dans l'option $select= et ils s'affichent dans les entrées de rapport, mais ils ne contiendront aucune donnée utile.
Les champs marqués [In/Out] dans les champs de table peut être utilisée dans les options de ($filter= et $orderby=) de restriction de l'entrée et la sélection de colonne ($select=). Lorsque vous incluez un de ces champs dans l'option $select= , il apparaîtra dans les entrées de rapport et contient des données utiles lorsqu'elle est disponible.
Compatibilité
Le rapport MailTraffic a été introduit dans Service Office 365 version 2013-V1. Pour plus d'informations sur le contrôle de version, consultez la rubrique Contrôle de version dans le service web de création de rapports Office 365.
Applets de commande Windows PowerShell correspondant
Le rapport MailTraffic renvoie les mêmes informations que l'applet de commande Get-MailTrafficReportWindows PowerShell.
Autorisations
Le compte que vous utilisez pour accéder aux rapports doit avoir des autorisations d'administration dans l'organisation Office 365. Si le compte peut afficher ce rapport dans le Office 365 le panneau de configuration, puis le compte dispose des autorisations pour récupérer les données à partir du service web REST. Ce rapport oblige l'utilisateur à être affecté au rôle destinataires de l'affichage seul. Dans la structure des autorisations Office 365 par défaut, les utilisateurs disposant des autorisations d'administrateur suivantes peuvent accéder à ce rapport : administrateur, administrateur général, le mot de passe et administrateur de facturation, administrateur de service, administrateur de gestion des utilisateurs. Pour plus d'informations, voir Rapport d'utilisation de la boîte aux lettres :.
Disponibilité, persistance et la granularité des données
Les informations disponibles dans cet état sont stockées avec exacte date et heure de chaque événement. Vous pouvez utiliser n'importe quel réalisable-période plus longue et la durée en incluant les champs StartDate et EndDate dans l'option $filter . Temps sont déclarés dans le fuseau horaire du serveur d'analyse du courrier électronique. Ce rapport calcule le décompte des messages sur les heures ou jours, en fonction du champ AggregateBy .
Les informations de ce rapport sont disponibles pour une période de 14 jours, ou jusqu'à ce que l'abonnement est annulé.
Les événements peuvent être retardées par jusqu'à 24 heures avant qu'ils s'affichent dans un rapport.