Search status, Reports, Search reports – Google Search Appliance Administrative API Developers Guide: .NET User Manual
Page 41

Google Search Appliance: Administrative API Developer’s Guide: .NET
41
Search Status
Retrieve the search status for the search appliance using the servingStatus entry of the status feed.
Retrieving Search Status
Retrieve the current search appliance serving status as follows:
GsaEntry myEntry = myService.GetEntry("status", "servingStatus");
Console.WriteLine("Queries Per Minute: " + myEntry.GetGsaContent
("queriesPerMinute"));
Reports
The sections that follow describe how to configure the Reports features of the Admin Console:
•
•
Search Reports
Generate, update, and delete search reports using the searchReport feed.
Search report entry properties:
Property
Description
queriesPerMinute
Average queries per minute served recently on the search appliance.
searchLatency
Recent search latency in seconds.
Property
Description
collectionName
(Write only) The collection name—only use to create a search report.
diagnosticTerms
Terms to exclude when running scripts that create diagnostic data from
test queries. All the specified terms in a search query are removed
from the report. Use commas to separate multiple terms.
Entry Name
Search_Report_Name@Collection_Name
isFinal
(Read only) Indicates if a search report contains a final result. If so, it
means the last update date is later than the reportDate.
reportContent
(Read only) The search report content. Only use for requests to get
search report content when the content is ready.
reportCreationDate
(Read only) The creation date of a search report.
reportDate
The dates of each query that is collected in the search report.
reportName
(Write only) The report name—only use to create a search report.