Previewing results

The Preview section enables you to check if specific records are indexed and test different search queries.

The query editor has two modes, a simple and an advanced mode. If all you want to do is run a search query and check if the expected results are returned, the simple search mode is all you need.

In the advanced mode (⋯) you can run more complex queries, test different Pipelines and versions of those Pipelines.

Advanced query editor

Query options

The advanced editor allows you to create more sophisticated queries using JSON syntax. Aside from specifying the search term, you can specify: the fields to be returned, filters to limit results, how many results should be on each results page and which page of results to return.

Property	Default	Description
q	""	The search query.
filter	""	Filter expression to limit results.
resultsPerPage	"10"	Number of results to show per page.
page	"1"	The result page to be shown. For example 3 would should the 3rd page of the results.
fields	""	What fields are shown depends on the Pipeline configuration. Use "" to show all fields.

The fields (title, URL, etc) of a search result may differ for each pipeline depending on how its configured. The RAW pipeline will display all fields by default.

Example - Running a blank query

{
 "q": "",
 "filter": "_id != ''"
}

The above example will return:

• results for a blank query

For those results, the response will:

• show only the fields specified by the pipeline (e.g. website pipeline returns title, description, url, and image)

• with 10 results per page (default)

Note: The filter "filter": "_id != ''" is required if you are running a blank query (i.e. "q":"").

Example - Filter records using operators

{
 "q": "mars",
 "filter": "domain='www.example.com' AND dir1='blog'",
 "fields": "",
 "resultsPerPage": 5,
 "page": 2
}

The above example will return:

• results matching the search query "mars"

• results filtered by the domain www.example.com AND the subdirectory /blog

For those results, the response will:

• show all available fields (Click on "Expand All" to un-collapse)

• with a limit of 5 results per page

• starting on page 2 (results 6-10)

Example - Filter records based on a timestamp field

{
 "q": "",
 "filter": "published_time>'2018-01-20'",
 "fields": "title,published_time"
}

The above example will return:

• all results that have been published after 20th January, 2018.

For those results, the response will:

• only show title and published_time field

Note: You can also use UNIX and RFC3339 formats. View this tool to convert time/date into Unix format.

Example - Check which records are affected by boost rules

{
 "q": "",
 "fields": "url, boost",
 "filter": "boost!=50"
}

The above example will return:

• all results that have boost value other than 50.

For those results, the response will:

• only show URL and boost values

Note: When a website is crawled, a boost value of 50 is assigned by default

The properties used in the examples above are specific to a Site Search collection. These properties might be different if you are using a custom collection.