Google Search Appliance Protocol Reference - Manual (Page 88)

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 88
Dynamic Result Clustering Request
Administrators can test the /cluster feature by submitting a custom HTTP POST form.
The search appliance processes cluster requests:
1. The cluster request inherits all request parameters and the search appliance transports the
parameters into an internal search query. If any of the /search parameters (see “Search
Parameters” on page 10) are present in the parameter list for the request to /cluster, they are
passed to the internal search request.
2. If custom parameters exist, the search appliance submits the parameters without filtering.
The POST request must have all the parameters encoded in the URI.
The clustering service recognizes the following parameter (in addition to the /search parameters,
see “Search Parameters” on page 10).
3. The search appliance stylesheet adds all parameters to the request related to the current search
query, as well as the custom parameters. Although the search appliance passes all parameters, not
all are used.
Dynamic Result Clustering JSON Request and
Response
The following example HTML provides a POST form that you can use to get JSON output (statements are
wrapped for readability). The query is for the island of Culebra.
HTTP POST to view JSON for dynamic result clustering head>
Click the Post button to view the JSON response.
Parameter Description Default Value
coutput Cluster output type: json or xml. Indicates the output you
requested. Specify json for JSON output on /cluster POST
requests.
Specify xml for XML output as either a GET or POST. The xml value
is generally used with /cluster as a RESTful service and the GET
method.
All request parameters must appear in the URI of a POST request.
json