.NET Search Query String Parameters

The URL of a Coveo .NET Front-End search interface can include one or more query string parameters. You can use these parameters to perform more specific queries.

Manually specifying query string parameters can be useful for administrators and developers while troubleshooting Coveo Platform issues.

.NET Search Query String Syntax

The query string syntax can include one of more parameter/value pairs as follows: 

http://CoveoSearch:[port]/?param1=value&param2=value

where:

[port]	Default is 8080. Can be omitted when it is 80.
[default.aspx]	Optional ASPX file name
?	Marks the start of the query string.
param[n]	Name of a query string parameter.
=	Operator separating the query string parameter and its value.
value	Value for the parameter. When a value contains more than one space separated term, replace the spaces with %20.
&	Operator separating two parameter/value pairs.

Generic Query String Parameters

The following table alphabetically lists available query string parameters.

Parameter	Description	Possible values
c	Collection to which you want to narrow the search.	One or more comma-separated collection names
ci	Collection to which you want to narrow the search.	One or more comma-separated collection IDs
debug	Displays debugging information (see Getting Debug Information from a .NET Search Interface).	1
disableanalyticslogging	Disables Usage Analytics Module logging.	1
ea	Email address to use in the email search interface.	Email address
exds	Exports the query results to an XML data source for Microsoft Excel.	1
f	Identifies the target HTML frame.	HTML frame name
lcid	Sets the search interface language.	7 (German), 9 (English), 10 (Spanish), 12 (French) , 19 (Dutch), 22 (Portuguese)
mode	Opens a specific search panel.	Normal, AdvancedSearch, Preferences, DesktopSearch Default Value: Normal
opensearch	Retrieves the OpenSearch description document.	1
opensearchsuggest	Retrieves query suggestions through OpenSearch	String of one or more terms
q	Queries specified terms.	String of one or more terms
rdb	Readability improved	true|false
sc	Sets search scope (for SharePoint search interface only).	AllSharePoint, CurrentSharePointTopLevelSite, CurrentSharePointSite, CurrentSharePointList, AllResults
sg	Usage Analytics action GUID	GUID string
sh	Sets the search hub.	Hub name
sk	Search interface used to display results.	Name of the interface
sortd	Sets sort order: descending Boolean	true, false] Default: false
sortf	Sets the sort field.	Field name prefixed with @ (the field must be a Sort By field (see Adding a Sorting Field))
tz	Sets the time zone ID. Note: CES 7.0.7022+ (September 2014) The index handles daylight saving time.	see TZID in Zone TZID
wakeup	Wakes up the search interface.	1
wld	Enables the wildcard search.	true|false

A parameter value 1 means that the parameter acts like a switch, its function being activated independently of the its value.

Advanced Search Query String Parameters

The following table lists query string parameters used to narrow search results in relation with the Advanced Search page (see Using the Advanced Search Page in .NET Search Interfaces).

Parameter	Description	Possible values
addl	Results modified in the last n days or months (specified by addu).	The number of days or months
addu	Time unit for addl	Default is days when not specified. m (months)
addmin	Results modified from the start date.	yyyy/mm/dd
addmax	Results modified up to the end date.	yyyy/mm/dd
adf	Results for given file formats	doc, txt, pdf, xls, ppt, html, zip... (see Supported File Formats)
ads	Results of file size with operator specified by adsr	Size in bytes
adsr	Operator for the ads parameter	AtLeast, AtMost Default: AtLeast
adl	Results language	English, French, Spanish, German, Dutch, Portuguese (see Supported Languages)
adadd	Search result address	Address string
adaddop	Operator for adadd parameter	Contains, DoesNotContain, Matches
adit	Search result title	Title text
aditop	Operator for adit parameter	Contains, DoesNotContain, Matches
adaut	Search result author	Author name
adautop	Operator for adaut parameter	Contains, DoesNotContain, Matches

Query String Parameters for Developers

The following query string parameters are generally useful only to developers.

Parameter	Description	Possible values
CoveoForceOutlookAddin	Render the search interface as for the Outlook sidebar.	1
CoveoForceMobile	Forces the browser to be detected as a mobile device.	1
CoveoForceWindowsMobile	Forces the browser to be detected as a Windows mobile.	1
CoveoForceBlackBerry	Forces the browser to be detected as a BlackBerry.	1
CoveoForceIPhone	Forces the browser to be detected as an IPhone.	1
CoveoForceIPad	Forces the browser to be detected as an IPad.	1
CoveoForceAdvancedMobile	Forces the browser to be detected as an advanced mobile.	1

A parameter value 1 means that the parameter acts like a switch, its function being activated independently of its value.