reportRoot : getSharePointSiteUsageDetail

Espace de noms: microsoft.graph

Obtenir les détails sur l’utilisation du site SharePoint.

Note: Pour plus d’informations sur les différents affichages et noms des rapports, voir Rapports Microsoft 365 - Utilisation du site SharePoint.

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

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.

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é. Pour plus d’informations, consultez Autorisation pour les API de lire les rapports d’utilisation de Microsoft 365.

Requête HTTP

GET /reports/getSharePointSiteUsageDetail(period='{period_value}')
GET /reports/getSharePointSiteUsageDetail(date={date_value})

Paramètres de fonction

Dans l’URL de la requête, indiquez une valeur valide pour l’un des paramètres suivants.

Remarque : vous devez définir la période ou la date dans l’URL.

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

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é-authentifiées ne sont valides que pendant une courte période (quelques minutes) et ne nécessitent pas d’en-tête Authorization .

Le fichier CSV comporte les en-têtes de colonne suivants :

• Date d’actualisation du rapport
• Site Id
• URL du site
• Nom d’affichage du propriétaire
• Est supprimé
• Date de la dernière activité
• ID d’étiquette de confidentialité du site
• Partage externe
• Stratégie d’appareil non managée
• Emplacement géographique
• Nombre de fichiers
• Nombre de fichiers actifs
• Nombre de visites de page
• Nombre de pages consultées
• Nombre de liens anonymes
• Nombre de liens d’entreprise
• Lien sécurisé pour le nombre d’invités
• Lien sécurisé pour le nombre de membres
• Espace de stockage utilisé (octets)
• Espace de stockage alloué (octets)
• Modèle web racine
• Nom de propriétaire principal
• 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 des fichiers CSV.

Demande

Voici un exemple de demande.

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

Réponse

Voici un exemple de 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é a le schéma suivant.

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

Report Refresh Date,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,Site Sensitivity Label Id,External Sharing,Unmanaged Device Policy,Geo Location,File Count,Active File Count,Page View Count,Visited Page Count,Anonymous Link Count,Company Link Count,Secure Link For Guest Count,Secure Link For Member Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period

JSON

Voici un exemple qui retourne JSON.

Demande

Voici un exemple de demande.

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

Réponse

Voici un exemple de 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: 484

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "siteId": "siteId-value", 
      "siteUrl": "siteUrl-value", 
      "ownerDisplayName": "ownerDisplayName-value", 
      "ownerPrincipalName": "ownerPrincipalName-value", 
      "isDeleted": false, 
      "lastActivityDate": "2017-09-01", 
      "siteSensitivityLabelId": "SiteSensitivityLabelId-value",
      "externalSharing": false,
      "unmanagedDevicePolicy": "UnmanagedDevicePolicy-value",
      "geoLocation": "GeoLocation-value",
      "fileCount": 170, 
      "activeFileCount": 25, 
      "pageViewCount": 7, 
      "visitedPageCount": 3, 
      "anonymousLinkCount": 5,
      "companyLinkCount": 8,
      "secureLinkForGuestCount": 13,
      "secureLinkForMemberCount": 11,
      "storageUsedInBytes": 63442116, 
      "storageAllocatedInBytes": 2748779094400, 
      "rootWebTemplate": "Publishing Site", 
      "reportPeriod": "7"
    }
  ]
}