Request parameters – Google Search Appliance Protocol Reference User Manual
Page 102

Google Search Appliance: Search Protocol Reference
Advanced Search Reporting Service /click Protocol
102
7.
The search appliance takes the /click URL information and uses the URL to write advanced search
reporting information to a log file. Administrators view the log on the Admin Console. For more
information on advanced search reporting and the Admin Console, see “Gathering Information
about the Search Experience” in Creating the Search Experience.
Request Parameters
Advanced search reporting requires the site parameter. Ensure that you include &site=collection in
request URLs, where collection is the collection being queried.
The end user does not see a /click URL. If an administrator uses a program such as tcpdump to view
data on the Internet connection, the /click information is visible. Administrators or programmers can
use this information for debugging or in an application. The parameters in the /click URL are as
follows.
URL Parameter
Description
Example
cd
Click data. This is additional, user-provided
information to give more information or context
about the click. This is not interpreted by the
search appliance and is just logged. This would
typically only be used by people who perform
advanced customization and need to log
additional information.
cd=malta
ct
Required parameter. Click type. A value that
identifies the type of link that a user clicks. For
the value, use underscores or a dot without
spaces and use alpha-numeric characters. For a
complete list of click types, see “Click Types in
Advanced Search Reports” in Creating the Search
Experience.
This is an extensible field. You can add your own
values to this parameter. We recommend that
you do not use any values that Google has
already defined. We recommend that you use a
sequence containing alpha-numeric characters,
underscores, hyphens, and periods.
ct=c
q
Query text
q=island+countries
r
Rank of the result on which the user clicks.
r=7
s
Specifies the index number of the first entry in
the result set.
s=24