reportRoot: getSharePointSiteUsageDetail

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Abrufen von Details zu SharePoint-Websiteverwendung.

Hinweis: Ausführliche Informationen zu verschiedenen Berichtsansichten und -namen finden Sie unter Microsoft 365 Berichte – SharePoint Websitenutzung.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto) Reports.Read.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt
Anwendung Reports.Read.All

Hinweis: Damit delegierte Berechtigungen Apps erlauben, Servicenutzungsberichte im Namen eines Benutzers zu lesen, muss der Mandant-Administrator dem Benutzer die entsprechende eingeschränkte Administratorrolle von Azure AD zugewiesen haben. Weitere Informationen finden Sie unter Berechtigung für APIs zum Lesen von Microsoft 365-Verwendungsberichten.

HTTP-Anforderung

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

Funktionsparameter

Geben Sie in der Anforderungs-URL einen der folgenden Parameter mit einem gültigen Wert an.

Parameter Typ Beschreibung
Zeitraum Zeichenfolge Gibt die Zeitspanne an, für die der Bericht aggregiert wird. Die unterstützten Werte für {period_value} sind: D7, D30, D90 und D180. Diese Werte folgen dem Format D n, wobei n die Anzahl der Tage angibt, für die der Bericht aggregiert wird.
date Datum Gibt das Datum an, für das die Benutzer angezeigt werden sollen, die Aktivitäten durchgeführt haben. {date_value} muss im Format JJJJ-MM-TT vorliegen. Da dieser Bericht nur für die letzten 30 Tage verfügbar ist, sollte {date_value} ein Datum aus diesem Zeitraum sein.

Hinweis: Sie müssen in der URL entweder einen Zeitraum oder ein Datum festlegen.

Diese Methode unterstützt die OData-Abfrageparameter von $format, $top und $skipToken zur Anpassung der Antwort. Der Standardausgabetyp ist "text/csv". Wenn Sie jedoch den Ausgabetyp angeben möchten, können Sie den OData-$format Abfrageparameter verwenden, der auf text/csv oder application/json festgelegt ist.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich.

Antwort

CSV

Wenn diese Methode erfolgreich ist, wird eine 302 Found-Antwort zurückgegeben, die zu einer vorauthentifizierten Download-URL für den Bericht umleitet. Die URL finden Sie in der Location-Kopfzeile der Antwort.

Zuvor authentifizierte Download-URLs sind nur für einen kurzen Zeitraum (einige Minuten) gültig und erfordern keinen Authorization-Header.

Die CSV-Datei verfügt über die folgenden Spaltenheader:

  • Berichtsaktualisierungsdatum
  • Website-ID
  • Website-URL
  • Anzeigename des Besitzers
  • Ist gelöscht
  • Datum der letzten Aktivität
  • Id der Website-Vertraulichkeitsbezeichnung
  • Externe Freigabe
  • Nicht verwaltete Geräterichtlinie
  • Geografischer Standort
  • Anzahl der Dateien
  • Anzahl der aktiven Datei
  • Anzahl der angezeigten Seiten
  • Anzahl der besuchten Seiten
  • Anzahl anonymer Links
  • Anzahl der Unternehmenslinks
  • Sicherer Link für die Anzahl der Gäste
  • Secure Link For Member Count
  • Verwendeter Speicherplatz (Byte)
  • Zugewiesener Speicherplatz (Byte)
  • Stammweb-Vorlage
  • Besitzerprinzipalname
  • Berichtszeitraum

JSON

Bei erfolgreicher Ausführung gibt die Methode den 200 OK Antwortcode und ein JSON-Objekt im Antworttext zurück.

Die Standardseitengröße für diese Anforderung beträgt 200 Elemente.

Beispiel

CSV

Im folgenden Beispiel wird CSV ausgegeben.

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

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

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

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

Führen Sie die Umleitung 302 aus, und die heruntergeladene CSV-Datei besitzt das folgende Format.

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

Im Folgenden sehen Sie ein Beispiel, das JSON zurückgibt.

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

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

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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