Partager via

reportRoot : getMailboxUsageDetail

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenir les détails sur l’utilisation de la boîte aux lettres.

Remarque : Pour plus d’informations sur les différents noms et vues de rapport, reportez-vous à l’article relatif aux rapports Microsoft 365 - utilisation de boîte aux lettres.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Reports.Read.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Reports.Read.All Non disponible.

Remarque : Pour que les autorisations déléguées permettent aux applications de lire les rapports d’utilisation du service pour le compte d’un utilisateur, l’administrateur client doit avoir attribué à l’utilisateur le rôle d’administrateur limité d’ID Microsoft Entra approprié. Si vous souhaitez en savoir plus, veuillez consulter la rubriqueAutorisation pour les API de lire les rapports d'utilisation de Microsoft 365.

Requête HTTP

GET /reports/getMailboxUsageDetail(period='{period_value}')

Paramètres de fonction

Dans l’URL de la requête, indiquez une valeur valide pour le paramètre suivant.

Paramètre Type Description
point string Spécifie la durée de regroupement du rapport. Les valeurs prises en charge pour {period_value} sont les suivantes : D7, D30, D90 et D180. Ces valeurs suivent le format Dn, où n représente le nombre de jours pendant lesquels le rapport est regroupé. Obligatoire.

Cette méthode prend en charge les $formatparamètres de requête OData , $topet $skipToken pour personnaliser la réponse. Le type de sortie par défaut est text/csv. Toutefois, si vous souhaitez spécifier le type de sortie, vous pouvez utiliser le paramètre de requête OData $format défini sur text/csv ou application/json.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Réponse

CSV

Si elle réussit, cette méthode renvoie une réponse 302 Found qui redirige vers une URL de téléchargement préalablement authentifiée pour le rapport. Cette URL est accessible dans l’en-tête Location de la réponse.

Les URL de téléchargement préalablement authentifiées ne sont valides que pour une courte durée (quelques minutes) et ne nécessitent pas d’en-tête Authorization.

Le fichier CSV comporte les en-têtes de colonnes suivants.

  • Date d’actualisation du rapport
  • Nom d’utilisateur principal
  • Nom d’affichage
  • Est supprimé
  • Date de suppression
  • Date de création
  • Date de la dernière activité
  • Nombre d’éléments
  • Espace de stockage utilisé (octets)
  • Quota d’émission d’avertissement (octets)
  • Quota d’interdiction d’envoi (octets)
  • Quota d’interdiction d’envoi/de réception (octets)
  • Nombre d’éléments supprimés
  • Taille de l’élément supprimé (octets)
  • Quota d'articles supprimés (octet)
  • Possède un Archive
  • Période du rapport

JSON

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet JSON dans le corps de la réponse.

La taille de page par défaut pour cette demande est de 200 éléments.

Exemple

CSV

Voici un exemple qui génère un fichier CSV.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/reports/getMailboxUsageDetail(period='D7')?$format=text/csv

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

Suivez la redirection 302 et le fichier CSV téléchargé aura le schéma suivant.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Created Date,Last Activity Date,Item Count,Storage Used (Byte),Issue Warning Quota (Byte),Prohibit Send Quota (Byte),Prohibit Send/Receive Quota (Byte),Deleted Item Count,Deleted Item Size (Byte),Deleted Item Quota (Byte),Has Archive,Report Period

JSON

Voici un exemple qui retourne JSON.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/reports/getMailboxUsageDetail(period='D7')?$format=application/json

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "userPrincipalName": "userPrincipalName-value", 
      "displayName": "displayName-value", 
      "isDeleted": false, 
      "deletedDate": null, 
      "createdDate": "2016-03-30", 
      "lastActivityDate": "2017-09-01", 
      "itemCount": 138481, 
      "storageUsedInBytes": 10414748704, 
      "deletedItemCount": 138481,
      "deletedItemSizeInBytes": 10414748704, 
      "deletedItemQuota": 107374182400,
      "hasArchive": true,
      "issueWarningQuotaInBytes": 10522698752, 
      "prohibitSendQuotaInBytes": 10630040576, 
      "prohibitSendReceiveQuotaInBytes": 10737418240, 
      "reportPeriod": "7"
    }
  ]
}