Compartir a través de

reportRoot: getSharePointSiteUsagePages

  • 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 el número de páginas vistas en todos los sitios.

Nota: Para obtener más información sobre los diferentes nombres y vistas de informe, vea Informes de Microsoft 365: uso del sitio de SharePoint.

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, consulte Autorización para que las API lean los informes de uso de Microsoft 365.

Solicitud HTTP

GET /reports/getSharePointSiteUsagePages(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 el $formatparámetro de consulta 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 direcciones URL de descarga autenticadas previamente solo son válidas durante un breve período de tiempo (unos minutos) y no requieren un Authorization encabezado.

El archivo CSV tiene los siguientes encabezados de columna.

  • Fecha de actualización del informe
  • Tipo de sitio
  • Número de vistas de página
  • Fecha del informe
  • 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.

Ejemplo

CSV

Este es un ejemplo que genera CSV.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/reports/getSharePointSiteUsagePages(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 que descarga tiene el siguiente esquema.

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

Report Refresh Date,Site Type,Page View Count,Report Date,Report Period

JSON

Este es un ejemplo que devuelve JSON.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/reports/getSharePointSiteUsagePages(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: 243

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "siteType": "All", 
      "pageViewCount": 183, 
      "reportDate": "2017-09-01", 
      "reportPeriod": "7"
    }
  ]
}