beautypg.com

Reports, Search reports – Google Search Appliance Administrative API Developers Guide: Protocol User Manual

Page 55

background image

Google Search Appliance: Administrative API Developer’s Guide: Protocol

55

The following result is an entry that includes the current serving status values for the search appliance:


xmlns:gsa="http://schemas.google.com/gsa/2007">
http://gsa:8002/feeds/status/servingStatus
2014-03-14T16:05:56.668Z


servingStatus
0.07
0.6

Reports

The sections that follow describe how to configure the Reports features of the Admin Console:

“Search Reports” on page 55

“Search Logs” on page 60

Search Reports

Generate, update and delete search log using the searchReport feed and the following properties.

Property

Description

<Entry Name>

<Search_Report_Name>@<Collection_Name>

collectionName

(Write only) The collection name, which is only needed when creating 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.

isFinal

(Read only) Indicates if the search report contains the final result. If so, it
means the last update date is later than reportDate.

reportContent

(Read only) The search report content, which is only returned when get
search report content and content is ready.

reportCreationDate

(Read only) The creation date of the search report.

reportDate

The dates of the queries that are collected in the search report.

reportName

(Write only) The report name, which is only needed when creating a search
report.

reportState

(Read only) The status of the search report. 0: Initialized; 1: Report in
progress; 2: Report competed; 3: Non-final complete report is being
generated; 4: Last report generation failed.