SPUsageReportType Enumeration
The SPUsageReportType enumeration specifies the type of information returned in a usage report for a SharePoint site.
Members
The following table shows the members of the SPUsageReportType enumeration and a brief description of the context for each report type.
| Name | Description |
|---|---|
| browser | The type of Web browser used to visit the SharePoint site. All usage data refers specifically to visits from referring URLs external to the site. |
| os | The operating system used on the client computer. All usage data refers specifically to visits from referring URLs external to the site. |
| refUrl | External URLs through which users navigated to the SharePoint site. |
| url | URLs of pages that are visited or of pages for lists that are updated. Discussions about a page are counted as hits on that page. |
| user | Users who visited the site. |
Remarks
In usage reports created by using one of the GetUsageData methods of the SPWeb class, the SPUsageReportType enumeration is used together with the SPUsagePeriodType enumeration to define the information returned. The following tables show the column names and describe the values returned for different combinations of report types and period types.
The period type is lastMonth and the report type is browser, os, refUrl, or user.
| Column Name | Browser, OS, Referrer URL, or User | Total Hits | Recent Month | Most Recent Day | Most Recent Day Hits |
| Description | The name and version of the browser, the name of the operating system, the absolute URL of the external site, or the user name (in other words, DOMAIN\User). | The total number of times a document has been accessed on the site.* | The total number of hits for the last 31 days.* | The most recent day that the document has been hit.* | The total number of hits on the most recent day.* |
The period type is day and the report type is browser, os, refUrl, or user.
| Column Name | Browser, OS, Referrer URL, or User | Names for columns 1 to 32 are the month and day in the format Mmm dd. |
| Description | The name and version of the browser, the name of the operating system, the absolute URL of the external site, or the user name (in other words, DOMAIN\User). | Hits on that day.* |
The period type is lastMonth and the report type is url.
| Column Name | Page | Folder | Total Hits | Recent Month | Most Recent Day | Most Recent Day Hits |
| Description | The name of the page or file that was hit or List update when a list is updated. | The site-relative path of the page or file, excluding the name. | The total number of hits. | The total number of hits for the last 31 days. | The date the page or file was most recently accessed. | The total number of hits for the most recent day. |
The period type is day and the report type is url.
| Column Name | Page | Folder | Names for columns 1 to 32 are the month and day in the format Mmm dd. |
| Description | The name of the page or file that was hit or List update when a list is updated. | The site-relative path of the page or file, excluding the name. | Hits on that day. |
* For Browser and OS, "hits" are replaced with "visits," which refer specifically to cases where a user has navigated to the site from a referring URL external to the site.
Requirements
Namespace: Microsoft.SharePoint.Administration
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Security: Code Access Security