Listing a search report – Google Search Appliance Administrative API Developers Guide: Protocol User Manual

Page 56

Advertising
background image

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

56

Listing a Search Report

List a search report using the following query parameters:

To list search report entries, send an authenticated GET request to the root entry of the searchReport
feed.

http://Search_Appliance:8000/feeds/searchReport/

A list of search report entries are returned.

<?xml version=’1.0’ encoding=’UTF-8’?>

<feed xmlns=’http://www.w3.org/2005/Atom’

xmlns:openSearch=’http://a9.com/-/spec/opensearchrss/1.0/’
xmlns:gsa=’http://schemas.google.com/gsa/2007’>

<id>http://gsa:8000/feeds/searchReport</id>
<updated>2009-03-26T07:26:55.991Z</updated>
<link rel=’http://schemas.google.com/g/2005#feed’

type=’application/atom+xml’ href=’http://gsa:8000/feeds/searchReport’/>

<link rel=’self’ type=’application/atom+xml’

href=’http://gsa:8000/feeds/searchReport’/>

<generator version=’0.5’ uri=’http://gsa:8000/gsa’>

Google Search Appliance

</generator>
<openSearch:startIndex>1</openSearch:startIndex>

topCount

The number of top queries to be generated.

withResults

Indicates if a search has results. The default value is false.

Parameter

Description

collectionName

Collection name for the search report. The default value is
all.collections.

Property

Description

Advertising