GetUsageBlob Method

  • Article

Applies to: SharePoint Foundation 2010

Returns information about the usage of a Web site.

<Method ID="Text">
  <SetVar Name="Cmd">GetUsageBlob</SetVar>
  <SetVar Name="BlobType">[Current|Old]</SetVar>
</Method>

Parameters

Parameter

Description

Name = "Cmd"

Must be set to GetUsageBlob.

Name = "BlobType"

Can be set to either Current, which returns data starting from the last day that usage processing was run and going back through the previous 31 days, or Old, which returns data going back through the previous 31 calendar months including the month of the last roll-over day. The roll-over day is the day of every month when site usage data is gathered from the daily "blob" and moved to the monthly blob.

Remarks

The GetUsageBlob method returns all usage data for a site, while the GetUsageData method of the Microsoft.SharePoint.SPWeb class returns only 2000 records. GetUsageBlob works for both GET and POST operations, but the returned data cannot be displayed in the browser.

For more information about the GetUsageBlob method and a tool that implements this method to return usage event data, download the Windows SharePoint Services: Usage Blob Parser. For general information about usage event logging, see Usage Event Logging in Windows SharePoint Services.

Decoded

<Method ID="0,GetUsageBlob">
  <SetVar Name="Cmd">GetUsageBlob</SetVar>
  <SetVar Name="BlobType">Current</SetVar>
</Method>