search

This performs a normal search based on the query/queries provided.

Parameters:

profile - Required. Specifies which profile you're working with.
query - Required. The Metamorph query to search for.

The following parameters can be provided to further refine the search:

urlQuery - Used for URL Prefix queries. Corresponds to the default search interface's uq query-string variable (here).
depthQuery - the maximum depth that would be allowed. Supplying a value of 3 would only return pages that are no more than 3 clicks away from a Base URL. Corresponds to the default interface's dq variable.
categoryName - name of a category to limit results to. Corresponds to the default interface's category variable. Added in version 20.1.
categoryQuery - numeric index for a category to limit results to. 1 is the first category, etc. Corresponds to the default interface's cq variable. Deprecated; use categoryName instead.
requireAllCategories - Set to Y to require each result to match all categories specified, instead of any of them.
proximity - specifies a required proximity for the words in the query. Corresponds to the default interface's prox variable. Possible values are:
- page - words must occur on the same page (default)
- paragraph - words must occur in the same paragraph
- sentence - words must occur in the same sentence.
- line - words must occur on the same line.
authUser - Username to use for Results Authorization, when using the Basic/NTLM/file - prompt via form authorization method.
authPass - Password to use for Results Authorization, when using the Basic/NTLM/file - prompt via form authorization method.
groupBy - restrict the Group Bys performed to one or more named fields. The Group Bys must still be configured in the admin interface (see here), but the <groupBy> parameter allows you to further restrict Group Bys to fewer than would be performed otherwise.

The search function may also use the rankKnobs structure (section 6.25.8, here).

Parametric Search

In addition to using the infield: syntax in the query, embedded parameters for the Parametric Search Query may also be provided. Param elements with name attributes are used to accomplish this.

For example, To set the embedded parameter qpMaxPrice to 20, use:

<Param name="qpMaxPrice">20</Param>

Please see Parametric Search Query (here) for more info.

Response

The SOAP output of the function is described in the XML Elements in Search Results section (6.15.3, here).