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.

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 au nom d’un utilisateur, l’administrateur client doit avoir attribué à l’utilisateur le rôle d’administrateur approprié Microsoft Entra limité. 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/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.

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é.
date	Date	Spécifie la date à laquelle vous voulez afficher les utilisateurs ayant effectué une activité. La valeur {date_value} doit suivre le format AAAA-MM-JJ. Sachant que ce rapport est disponible uniquement pour les 30 derniers jours, la valeur {date_value} doit être comprise dans cette plage.

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

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
If-None-Match	Si cet en-tête de demande est inclus et que l’eTag fourni correspond à la balise actuelle sur le fichier, un code de réponse 304 Not Modified est renvoyé. Facultatif.

Réponse

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
• Site Id
• URL du site
• Nom d’affichage du propriétaire
• Est supprimé
• Date de la dernière activité
• Nombre de fichiers
• Nombre de fichiers actifs
• Nombre de visites de page
• Nombre de pages consultées
• Espace de stockage utilisé (octets)
• Espace de stockage alloué (octets)
• Modèle web racine
• Nom de propriétaire principal
• Période du rapport

Exemple

Demande

L’exemple suivant illustre une demande.

HTTP

GET https://graph.microsoft.com/v1.0/reports/getSharePointSiteUsageDetail(period='D7')

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetSharePointSiteUsageDetailWithPeriod("{period}").GetAsync();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc reports get-share-point-site-usage-detail-with-period get --period {period-id}

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



period := "{period}"
graphClient.Reports().GetSharePointSiteUsageDetailWithPeriod(&period).Get(context.Background(), nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getSharePointSiteUsageDetailWithPeriod("{period}").get();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getSharePointSiteUsageDetail(period='D7')')
	.get();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getSharePointSiteUsageDetailWithPeriod('{period}', )->get()->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.reports.get_share_point_site_usage_detail_with_period("{period}").get()

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

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,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,File Count,Active File Count,Page View Count,Visited Page Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period