SharePointSiteUsageDetail
Provides aggregated metrics on SharePoint site usage, including file storage, number of active users, and site visits. This is useful for managing site performance and relevance.
Select
The cmdlet uses the Microsoft Exchange API to process WHERE clause conditions built with the following columns and operators:
- Period supports the '=' operator.
- Date supports the '=' operator.
The rest of the filter is executed client-side in the cmdlet.
At a minimum, a Date or Period column is required to get the report data. By default, the driver makes a request of the period as D7 if no filter is specified.
For example, the following query is processed server-side:
SELECT * FROM SharePointSiteUsageDetail WHERE Period = 'D7' SELECT * FROM SharePointSiteUsageDetail WHERE Date = '2023-04-19'
Columns
| Name | Type | Description |
| ReportRefreshDate | Date | The date on which the SharePoint site usage report was last refreshed. This represents the latest available snapshot of usage metrics. |
| SiteId | String | The unique identifier assigned to the SharePoint site. Used internally to distinguish the site within Microsoft 365 and Azure Active Directory. |
| SiteURL | String | The full URL of the SharePoint site, allowing direct access to the site's homepage or document library. |
| OwnerDisplayName | String | The display name of the user listed as the owner of the SharePoint site. This is typically the user who created the site or was designated as the site administrator. |
| IsDeleted | String | Indicates whether the SharePoint site has been marked as deleted. A value of true signifies that the site is no longer active or accessible. |
| LastActivityDate | Date | The most recent date on which any activity—such as file uploads, edits, page views, or sharing—occurred on the SharePoint site. |
| FileCount | Integer | The total number of files currently stored within the SharePoint site, including all document libraries and folders. |
| ActiveFileCount | Integer | The number of files within the SharePoint site that were actively engaged with during the reporting period. This includes viewed, edited, or shared files. |
| PageViewCount | Integer | The total number of times pages within the SharePoint site were viewed by users. This includes site homepages, lists, and document libraries. |
| VisitedPageCount | Integer | The number of distinct page visits on the SharePoint site by users during the reporting period. This metric can differ from PageViewCount if users revisit pages multiple times. |
| StorageUsedByte | Integer | The amount of storage, in bytes, that the SharePoint site is currently consuming. This includes documents, metadata, site assets, and recycle bin contents. |
| StorageAllocatedByte | Long | The total amount of storage, in bytes, allocated to the SharePoint site. This quota is typically set by SharePoint administrators or based on licensing agreements. |
| RootWebTemplate | String | The web template used to create the root site of the SharePoint instance. Examples include STS#0 for team sites and BLOG#0 for blog sites. |
| OwnerPrincipalName | String | The user principal name (UPN) of the SharePoint site owner, generally formatted as an email address. Used for user identification and access management. |
| ReportPeriod | Integer | The number of days covered by the usage report, commonly 7, 30, 90, or 180. Indicates the timespan for which usage metrics have been aggregated. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Period | String | Defines the aggregation interval for the report. Valid values are D7, D30, D90, and D180, each representing the number of days included in the report.
The allowed values are D7, D30, D90, D180. The default value is D7. |
| Date | Date | The specific date (in YYYY-MM-DD format) for which SharePoint site usage data is requested. Only dates from the last 30 days are supported in this report. |