Compartir a través de

reportRoot: getMailboxUsageDetail

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Obtiene información sobre el uso de buzones.

Nota: Para obtener información sobre las diferentes visualizaciones y nombres de los informes, consulte Informes de Microsoft 365: Uso del buzón.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Reports.Read.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Reports.Read.All No disponible.

Nota: Para que los permisos delegados permitan a las aplicaciones leer informes de uso del servicio en nombre de un usuario, el administrador de inquilinos debe haber asignado al usuario el rol de administrador limitado id. de Microsoft Entra adecuado. Para obtener más información, vea Autorización para que las API lean informes de uso de Microsoft 365.

Solicitud HTTP

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

Parámetros de función

En la URL de la solicitud, especifique el siguiente parámetro de consulta con un valor válido.

Parámetro Tipo Descripción
period cadena Especifica la duración de tiempo durante la que se agrega el informe. Los valores admitidos para {period_value} son: D7, D30, D90 y D180. Estos valores tienen el formato Dn, donde n representa el número de días durante los que se agrega el informe. Necesario.

Este método admite los $formatparámetros de consulta , $topy $skipToken OData para personalizar la respuesta. El tipo de salida predeterminado es text/csv. Sin embargo, si desea especificar el tipo de salida, puede usar el parámetro de consulta OData $format establecido en text/csv o application/json.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Respuesta

CSV

Si se ejecuta correctamente, este método devuelve una respuesta 302 Found que redirige a una URL de descarga con autenticación previa para el informe. La URL se encuentra en el encabezado Location de la respuesta.

Las URL de descarga con autenticación previa solo son válidas durante un breve período de tiempo (unos minutos) y no necesitan un encabezado Authorization para descargarlas.

El archivo CSV tiene los siguientes encabezados de columna.

  • Fecha de actualización del informe
  • Nombre principal de usuario
  • Nombre para mostrar
  • Eliminado
  • Fecha de eliminación
  • Fecha de creación
  • Fecha de la última actividad
  • Número de elementos
  • Almacenamiento usado (bytes)
  • Cuota de advertencia de problema (bytes)
  • Cuota de prohibición de envío (bytes)
  • Cuota de prohibición de envío o recepción (bytes)
  • Recuento del elemento eliminado
  • Tamaño del elemento eliminado (byte)
  • Cuota del elemento eliminado (byte)
  • Tiene archivo
  • Período del informe

JSON

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto JSON en el cuerpo de la respuesta.

El tamaño de página predeterminado para esta solicitud es de 200 elementos.

Ejemplo

CSV

A continuación se muestra un ejemplo que genera CSV.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

Siga el redireccionamiento 302 y el archivo CSV descargado tendrá el esquema siguiente.

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

A continuación se muestra un ejemplo que devuelve JSON.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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"
    }
  ]
}