The SXA Search service

Abstract

Learn more about the SXA search API parameters and their usage.

SXA Search Service is an endpoint used by search components. Most search components available from the SXA toolbox consume data from the endpoint. This topic describes the SXA search API parameters and their purpose.

For each defined site, the SXA Search service registers the routes with the following endpoint URLs:

The results endpoint runs search and returns results. You can use the following parameters:

Query parameter

Description

Example value

q

query - returns the results with the specified word.

Renderings

v

variant - ID of the variant definition item used to render the result.

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

s

scope - ID of the scope definition item that provides predefined filtering.

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

l

language - language versions to include in the search result.

en|pl

en,pl

o

ordering - sorts the results based on specified facets.

Title,Descending

e

offset - excludes a specified amount of elements from the returned result.

30

p

page size - returns a specified amount of pages. The default value is 20.

20

g

geolocation - latitude and longitude of the geolocation used for spatial search.

55.676098|12.568337

sc_site

sitecore site - the name of the context site.

showcase

itemid

item ID - the current context item ID.

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

sig

signature - the search results signature.

my_signature_search

For example:

https://sxa94_003432/playground/sxa/search/results/?s={BAFF04C0-7332-4B72-A108-EE9814C62F16}&itemid={81003E8D-4232-433D-849E-6CA9574B5BD1}&v={2CA6BDE6-69BC-4D2A-AC6B-6DD88E300CF9}&p=20&o=Title,Ascending

The facets service searches for facets based on their name. You can use the following parameters:

Query parameter

Description

Example value

q

query - user string input to search for.

Renderings

s

scope - ID of the scope definition item that provides predefined filtering.

{A907975A-8C25-4433-A8ED-02B5FC1EBA29}

f

facets - facet item names to return.

Update date, Tags

l

language - language versions to include in the search result.

en|pl

g

geolocation - latitude and longitude of the geolocation used for spatial search

55.676098|12.568337

sig

signature - the search results signature

my_signature_search

For example:

https://sxa94_003432/playground/sxa/search/facets/?f=movie%20type,movie%20rated,movie%20genre&s={BAFF04C0-7332-4B72-A108-EE9814C62F16}&itemid={81003E8D-4232-433D-849E-6CA9574B5BD1}

By default, caching for search and facet requests is disabled. You can update the configuration in the Sitecore.XA.Feature.Search.config file:

SXA-search-service-enable.png