Google Search Appliance Administrative API Developers Guide: .NET - Manual (Page 42)

Google Search Appliance: Administrative API Developer’s Guide: .NET 42
Listing a Search Report
List search report entries by sending an authenticated GET request to the root entry of the
searchReport feed. Query parameter:
A list of search report entries returns:
GsaFeed myFeed = myService.GetFeed("searchReport");
foreach(GsaEntry entry in myFeed.Entries) {
Console.WriteLine("Entry Name: " + entry.GetGsaContent("entryID"));
Console.WriteLine("Report State: " + entry.GetGsaContent("reportState"));
Console.WriteLine("Report Creation Date: " +
entry.GetGsaContent("reportCreationDate"));
Console.WriteLine("Report Date: " + entry.GetGsaContent("reportDate"));
Console.WriteLine("Is Final: " + entry.GetGsaContent("isFinal"));
Console.WriteLine("With Results: " + entry.GetGsaContent("withResults"));
Console.WriteLine("Top Count: " + entry.GetGsaContent("topCount"));
Console.WriteLine("Diagnostic Terms: " +
entry.GetGsaContent("diagnosticTerms"));
}
Creating a Search Report
Create a new search report entry by sending an authenticated POST request to the root entry of the
searchReport feed.
The possible date formats for reports are as follows.
reportState (Read only) The status of a search report:
• 0: The search report is initializing.
• 1: The search report is generating.
• 2: The search report is complete.
• 3: A non-final complete report is generating.
• 4: The last report generation failed.
topCount The number of top queries to generate.
withResults Indicates if a query should only count searches that have results. The
default value is false.
Parameter Description
collectionName Collection Name of search report. The default value is
all.collections.
Purpose Format
Date date _month_day_year
Month month _month_year
Property Description