API Documentation Archives - SearchStax Docs Documentation Wed, 14 May 2025 18:24:53 +0000 en-US hourly 1 https://wordpress.org/?v=6.8.1 https://demo.searchstax.com/docs/wp-content/uploads/2023/10/cropped-favicon-32x32.png API Documentation Archives - SearchStax Docs 32 32 Popular Searches API https://demo.searchstax.com/docs/searchstudio/searchstax-studio-popular-searches-api/ Thu, 01 Sep 2022 17:11:44 +0000 https://demo.searchstax.com/docs/?post_type=searchstudio&p=12521 Popular Searches API SearchStax Site Search solution’s Popular Searches API retrieves the most Popular Searches recorded by the Search App during the previous 30 days. This page describes how to… Continue reading Popular Searches API

The post Popular Searches API appeared first on SearchStax Docs.

]]> Popular Searches API

SearchStax Site Search solution’s Popular Searches API retrieves the most Popular Searches recorded by the Search App during the previous 30 days.

This page describes how to retrieve a Json document of popular-search strings for display on your search page.

The API can be accessed through any tool that assembles HTTP requests and dispatch them to a server. Among these would be the Python coreapi package, the Postman tool, and cURL. For Windows, use PowerShell 7.

Symbols enclosed in carets (< and >) such as <username> are metavariables. Substitute your local values when you encounter them in the examples.

Popular Search

This method returns a list of Popular Searches from a Search App. The pool of searches covers the most recent 30 days of search history.

GET &lt;popular-searches-URL>?language=&lt;code>&amp;page=&lt;n>&amp;num_results=&lt;n>

where <popular-searches-URL> is an endpoint from the Discovery API Tab of the App Settings screen. Language is an optional two-letter language code. Page is an optional page within the paginated result set. Num_results is an optional limit on the number of searches desired (1 through 20).

This method uses Discovery API Key authorization. The Discovery API key is displayed on the Discovery API Tab. It must be passed in the header of the request.

When invoked from Linux (Bash shell):

curl 'https://app.searchstax.com/api/v1/nn/popular-search/?language=en&num_results=10' -H 'Authorization: f17e2131927b055383669327b1dc95338a7bdd7d'

The response is a JSON document containing a list of popular searches.

{
  "responseHeader": {
    "zkConnected": true,
    "status": 0,
    "QTime": 1
  },
  "response": {
    "numFound": 4,
    "start": 0,
    "numFoundExact": true,
    "docs": [
      {
        "query": "drupal integration",
        "count": 12
      },
      {
        "query": "solr",
        "count": 3
      },
      {
        "query": "sitecore",
        "count": 2
      },
      {
        "query": "test",
        "count": 2
      }
    ]
  }
}

The fields of each popular search have the following meanings:

  • query: The text of a popular search.
  • count: How many time the Search App has encountered this search.

The other fields are Solr internal values.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Popular Searches API appeared first on SearchStax Docs.

]]> Tracking API (REST) https://demo.searchstax.com/docs/searchstudio/searchstax-studio-analytics-rest-api/ Thu, 08 Jul 2021 22:25:44 +0000 https://demo.searchstax.com/docs/?post_type=site_search&p=9272 Tracking API (REST) This page describes how to add SearchStax Site Search solution’s Analytics Events to your search page. The Tracking API (Javascript) page describes how you can use a helper Javascript library… Continue reading Tracking API (REST)

The post Tracking API (REST) appeared first on SearchStax Docs.

]]> Tracking API (REST)

This page describes how to add SearchStax Site Search solution’s Analytics Events to your search page. The Tracking API (Javascript) page describes how you can use a helper Javascript library to push Analytics events. This document describes how the same events can be pushed using just a REST API.

Analytics URL, Key and the REST Endpoint

On the Settings page of your Search App, the Analytics API tab contains the base URL for the API and the Analytics Key. The analytics key identifies the Search App.

The Analytics REST endpoint is <Analytics URL>/api/v2/track/.

Example: https://analytics-us.searchstax.com/api/v2/track/

Different events can be pushed to this endpoint as described in the sections below.

Events

An “event” is a user action on your search page, such as searching for a keyword or clicking on a search result. SearchStax supports the following event messages:

Each type of event has its own set of required properties, which are detailed below. The following are the common properties across all events:

Parameter Description Example
key:
required
string  		 This is the unique analytics app key as shown in the “Analytics API” tab of your App within Search App Management ‘IeDTTDD1ubJdfPMmu7MMxxVjUMdw6vo52BjPixxqwcQ’
session:
required
string  		 The ID of the web session or mobile application session. If omitted, some analytics features cannot be fully reported. ‘qqMKt4fxhcud0T5c3UJ5spgug’
_vid:
required
string 		 Unique Identifier to identify a visitor ‘d7cc372a-2be6-ee1e-26e8-0f903fa36e67’

session can be obtained using the following helper function:

getSession : function(name){
	var name = 'searchcookie';
	var session = document.cookie.match(new RegExp('(^| )' + name + '=([^;]+)'));
	return session[2];
}

The “search” and “related-search” events are intended to be used in the following fashion:

  1. Your search page sends a query to the search API. The search results are returned. A track event fires to track the impressions from the search results.
  2. If using the related searches features, your search page sends a request to the related searches API to get related searches for the query. The related searches are returned. A trackRelatedSearch event fires to track the related searches that were returned
  3. If the user clicks on a document, a trackClick event fires to track which document was clicked on.
  4. If the user clicks on a related search, a trackRelatedSearchClick event fires to track which related search was clicked on.

Track Searches and Impressions

To track searches, create a data object as below, which specifies the event type as _search.

var searchObj = {
  "event": "_search",
  "properties": {
    "key": "imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0V1S58",
    "query": "sitecore",
    "shownHits": 3,
    "totalHits": 12,
    "pageNo": 1,
    "latency": 6,
    "session": "r6ivpxkd3e294kJ299V0tVb1q",
    "impressions": [
      {
        "cDocId": "https://www.searchstax.com/solutions/sitecore-solr/",
        "cDocTitle": "Managed Solr Service for Sitecore | SearchStax",
        "position": 1
      },
      {
        "cDocId": "https://www.searchstax.com/blog/site-search-for-sitecore-video/",
        "cDocTitle": "SearchStudio for Sitecore - Video | The Search Experience Blog",
        "position": 2
      },
      {
        "cDocId": "https://www.searchstax.com/solutions/sitecore-azure-to-solr-migration/",
        "cDocTitle": "Migrate Azure Search to Solr for Sitecore | SearchStax",
        "position": 3
      }
    ],
    "_vid": "d7cc372a-2be6-ee1e-26e8-0f903fa36e67",
    "language": "en"
  }
}

Parameter Description Example
event:
required
string		 Type of user action on the search page. ‘_search’
key:
required
string		 Unique Analytics API Key ‘IeDTTDD1ubJdfPMmu7MMxxVjUMdw6vo52BjPixxqwcQ’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘qqMKt4fxhcud0T5c3UJ5spgug’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore plugin’
shownHits:
optional
number		 The number of hits shown in the response document. 10
totalHits:
optional
number		 The number of hits in the index, from the response document.

Note: To track searches that returned no results, set totalHits to 0.

 1890
latency:
optional
number		 The number of milliseconds to execute a search. You define the semantics. (One possibility is to use Qtime from the response document). Without this value, Analytics will not calculate average latency. 150
pageNo:
optional
number		 The page number of the displayed results, from the response document. 1
impressions:
optional
array		 An array of dictionaries, each describing a search result “impression.”
It lets the Analytics App track the documents that were displayed to the user as search results, whether the user clicked on them or not		 [
{'cDocId': 'aDocId1', 'cDocTitle': 'aDocTitle1', 'position': 1},
{'cDocId': 'aDocId2', 'cDocTitle': 'aDocTitle2', 'position': 2}, ..
]
where cDocId is the unique ID of the document and cDocTitle is the title that is displayed for the search result.
The position numbers should start with 1
_vid:
required
string		 Unique Identifier for the visitor. d7cc372a-2be6-ee1e-26e8-0f903fa36e67
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

Calling the Analytics REST endpoint (/track API)

To call the REST API and insert the event, the event objects should be encoded to Base64 and passed as the data. For example, for the above request, you can use online base64 encoders such as https://www.base64encode.org/ to encode the object and then call the API endpoint as follows:

curl -vL "https://analytics-us.searchstax.com/api/v2/track/?data=ewogICJldmVudCI6ICJfc2VhcmNoIiwKICAicHJvcGVydGllcyI6IHsKICAgICJrZXkiOiAiaW1ETXJzNTZhVGFESmM2amloRGVqVWtEWllqM0dtOHJpSkhsUjBWMVM1OCIsCiAgICAicXVlcnkiOiAic2l0ZWNvcmUiLAogICAgInNob3duSGl0cyI6IDMsCiAgICAidG90YWxIaXRzIjogMTIsCiAgICAicGFnZU5vIjogMSwKICAgICJsYXRlbmN5IjogNiwKICAgICJzZXNzaW9uIjogInI2aXZweGtkM2UyOTRrSjI5OVYwdFZiMXEiLAogICAgImltcHJlc3Npb25zIjogWwogICAgICB7CiAgICAgICAgImNEb2NJZCI6ICJodHRwczovL3d3dy5zZWFyY2hzdGF4LmNvbS9zb2x1dGlvbnMvc2l0ZWNvcmUtc29sci8iLAogICAgICAgICJjRG9jVGl0bGUiOiAiTWFuYWdlZCBTb2xyIFNlcnZpY2UgZm9yIFNpdGVjb3JlIHwgU2VhcmNoU3RheCIsCiAgICAgICAgInBvc2l0aW9uIjogMQogICAgICB9LAogICAgICB7CiAgICAgICAgImNEb2NJZCI6ICJodHRwczovL3d3dy5zZWFyY2hzdGF4LmNvbS9ibG9nL3NpdGUtc2VhcmNoLWZvci1zaXRlY29yZS12aWRlby8iLAogICAgICAgICJjRG9jVGl0bGUiOiAiU2l0ZSBTZWFyY2ggZm9yIFNpdGVjb3JlIC0gVmlkZW8gfCBUaGUgU2VhcmNoIEV4cGVyaWVuY2UgQmxvZyIsCiAgICAgICAgInBvc2l0aW9uIjogMgogICAgICB9LAogICAgICB7CiAgICAgICAgImNEb2NJZCI6ICJodHRwczovL3d3dy5zZWFyY2hzdGF4LmNvbS9zaXRlY29yZS1henVyZS10by1zb2xyLW1pZ3JhdGlvbi8iLAogICAgICAgICJjRG9jVGl0bGUiOiAiTWlncmF0ZSBBenVyZSBTZWFyY2ggdG8gU29sciBmb3IgU2l0ZWNvcmUgfCBTZWFyY2hTdGF4IiwKICAgICAgICAicG9zaXRpb24iOiAzCiAgICAgIH0KICAgIF0sCiAgICAiX3ZpZCI6ICJkN2NjMzcyYS0yYmU2LWVlMWUtMjZlOC0wZjkwM2ZhMzZlNjciCiAgfQp9"

The above method returns an HTTP status code of 201/204 if the event was successfully added.

If the data is large, you should use POST instead of GET API.

If the data contains special characters, you should make sure it is URL encoded (Can test on https://www.urlencoder.org/)

DATA = urlEncode(base64encode(searchObj))
curl -v "https://analytics-us.searchstax.com/api/v2/track/?data=$DATA"

To track related searches, create a data object as below, which specifies the event type as _relatedsearch.

var relatedSearchObj = {
  "event":"_relatedsearch",
  "properties":{
    "session":"JKaqFFK088vyrTkIBwBeWDyhQ",
    "key":"IeDTTDD1ubJdfPMmu7MMxxVjUMdw6vo52BjPixxqwcQ",
    "query":"solr",
    "shownHits":2,
    "pageNo": 1,
    "impressions":[
      {"relatedSearch":"managed solr",
      "position":1},
      {"relatedSearch":"solr 7",
      "position":2}
    ],
    "_vid":"d7cc372a-2be6-ee1e-26e8-0f903fa36e67",
    "language": "en"
}}
Parameter Description Example
event:
required
string		 Type of user action on the search page. ‘_relatedsearch’
key:
required
string		 Unique Analytics API Key ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘XDJFNS355FGDFVVDFG’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore plugin’
shownHits:
optional
number		 The number of hits shown in the response document. 10
latency:
optional
number		 The number of milliseconds to execute a search. You define the semantics. (One possibility is to use Qtime from the response document). Without this value, Analytics will not calculate average latency. 150
impressions:
optional
array		 An array of dictionaries, each describing a related search “impression.”
It lets the Analytics App track the related searches that were displayed to the user as search results, whether the user clicked on them or not		 [
{'relatedSearch': 'an example related search', 'position': 1},
{'relatedSearch': 'another example related search', 'position': 2}, ..
]
where relatedSearch is the related search query. The position numbers should start with 1
_vid:
required
string		 Unique Identifier for the visitor. d7cc372a-2be6-ee1e-26e8-0f903fa36e67
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

Calling the Analytics REST endpoint (/track API)

To call the REST API and insert the event, the event objects should be encoded to Base64 and passed as the data. For example, for the above request, you can use online base64 encoders such as https://www.base64encode.org/ to encode the object and then call the API endpoint as follows:

curl -vL "https://analytics-us.searchstax.com/api/v2/track/?data=ewogICJldmVudCI6Il9yZWxhdGVkc2VhcmNoIiwKICAicHJvcGVydGllcyI6ewogICAgInNlc3Npb24iOiJKS2FxRkZLMDg4dnlyVGtJQndCZVdEeWhRIiwKICAgICJrZXkiOiJJZURUVEREMXViSmRmUE1tdTdNTXh4VmpVTWR3NnZvNTJCalBpeHhxd2NRIiwKICAgICJxdWVyeSI6InNvbHIiLAogICAgInNob3duSGl0cyI6MiwKICAgICJwYWdlTm8iOiAxLAogICAgImltcHJlc3Npb25zIjpbCiAgICAgIHsicmVsYXRlZFNlYXJjaCI6Im1hbmFnZWQgc29sciIsCiAgICAgICJwb3NpdGlvbiI6MX0sCiAgICAgIHsicmVsYXRlZFNlYXJjaCI6InNvbHIgNyIsCiAgICAgICJwb3NpdGlvbiI6Mn0KICAgIF0sCiAgICAiX3ZpZCI6ImQ3Y2MzNzJhLTJiZTYtZWUxZS0yNmU4LTBmOTAzZmEzNmU2NyIsCn19"

The above method returns an HTTP status code of 201/204 if the event was successfully added.

DATA = urlEncode(base64encode(searchObj))
curl -v "https://analytics-us.searchstax.com/api/v2/track/?data=$DATA"

Track Search Clicks

To start generating data around click-through events, search quality and relevance, have /track send _searchclick event to the Analytics App.

var searchClickObj = {
  "event": "_searchclick",
  "properties": {
    "key": "imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0V1S58",
    "query": "sitecore",
    "shownHits": 12,
    "totalHits": 143,
    "pageNo": 1,
    "latency": 6,
    "session": "jtVM0lqSBMEfmBDYBHaUjodIL",
    "cDocId": "https://www.searchstax.com/blog/site-search-for-sitecore-video/",
    "cDocTitle": "SearchStudio for Sitecore - Video | The Search Experience Blog",
    "position": 2,
    "_vid": "d7cc372a-2be6-ee1e-26e8-0f903fa36e67",
    "language": "en"
  }
}

Parameter Description Example
event:
required
string		 Type of user action on search page. ‘_searchclick’
key:
required
string		 Unique Analytics API Key ‘IeDTTDD1ubJdfPMmu7MMxxVjUMdw6vo52BjPixxqwcQ’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘qqMKt4fxhcud0T5c3UJ5spgug’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore’
cDocId:
required
string		 The document ID from the response document. ‘https://www.searchstax.com/blog/site-search-for-sitecore-video/’
cDocTitle
required
string		 The document title from the response document. Note: In some applications, the document title may change. Analytics can be calculated as long as cDocID remains constant. ‘SearchStax Studio for Sitecore – Video | The Search Experience Blog’
position:
required
number		 Absolute position of the document in the full list of results. If we’re showing ten items per page, the first result on the 5th page is position in position 41. First item on the first page has position as 1 2
pageNo:
optional
number		 The page number of the displayed results, from the response document. 1
pageUrl:
optional
string		 The URL of the page that is sending the tracking request ‘https://searchstudio.searchstax.com/search’
shownHits:
optional
number		 The number of hits shown in the response document. 10
totalHits:
optional
number		 The number of hits in the index, from the response document. 1890
_vid:
required
string		 Unique Identifier for the visitor. d7cc372a-2be6-ee1e-26e8-0f903fa36e67
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

To call the REST API and insert the event, the event object should be encoded to Base64 and passed as the data, just like for the _search event

DATA = urlEncode(base64encode(searchClickObj))
curl -v "https://analytics-us.searchstax.com/api/v2/track/?data=$DATA"

The above method returns an HTTP status code of 201/204 if the event was successfully added.

To start generating data around click-through events, search quality and relevance, have /track send _relatedsearchclick event to the Analytics App.

{"event":"_relatedsearchclick","properties":{"session":"JKaqFFK088vyrTkIBwBeWDyhQ","key":"tACKiVHqhd22wS3AEE3EYmKwbriokhs04Yja6uoAaXk","query":"solr","relatedSearch":"managed solr","pageNo":1,"shownHits":1,"totalHits":1,"_vid":"0b7fef5a-2deb-2e4e-15d3-5c8e4a19d58c","tt":1645231821464,"pageUrl":"https%3A%2F%2Fsearchstudio.searchstax.co%2Fapps%2Fyivdt5dND9n3WqjZOD5ZKIgbvzdz5lBH7gsVPRg6sAY%2Fsearch.html%3FsearchStudioQuery%3Dsolr%26style%3Dfalse%26facets%3D%26sort%3D%26start%3D0"}}

var searchClickObj = {
  "event": "_relatedsearchclick",
  "properties": {
    "key": "imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0V1S58",
    "query": "sitecore",
    "shownHits": 12,
    "totalHits": 143,
    "pageNo": 1,
    "latency": 6,
    "session": "jtVM0lqSBMEfmBDYBHaUjodIL",
    "relatedSearch": "Sitecore 7",
    "position": 2,
    "_vid": "d7cc372a-2be6-ee1e-26e8-0f903fa36e67",
    "language": "en"
  }
}
Parameter Description Example
event:
required
string		 Type of user action on search page. ‘_relatedsearchclick’
key:
required
string		 Unique Analytics API Key ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘XDJFNS355FGDFVVDFG’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore plugin’
position:
required
number		 Absolute position of the related search in the full list of results. If we’re showing ten related searches per page, the first related search on the 5th page is position in position 41. First related search on the first page has position as 1 41
relatedSearch:
required
string		 The related search term that was clicked on. ‘sitecore 7’
pageNo:
optional
number		 The page number of the displayed results, from the response document. 1
pageUrl:
optional
string		 The URL of the page that is sending the tracking request ‘https://searchstudio.searchstax.com/search’
shownHits:
optional
number		 The number of hits shown in the response document. 10
totalHits:
optional
number		 The number of hits in the index, from the response document. 1890
_vid:
required
string		 Unique Identifier for the visitor. d7cc372a-2be6-ee1e-26e8-0f903fa36e67
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

To call the REST API and insert the event, the event object should be encoded to Base64 and passed as the data, just like for the _relatedsearch event

DATA = urlEncode(base64encode(searchClickObj))
curl -v "https://analytics-us.searchstax.com/api/v2/track/?data=$DATA"

The above method returns an HTTP status code of 201/204 if the event was successfully added.

  

Track Search Satisfaction

SearchStax provides the ability to collect qualitative feedback about the search experience using the event _searchSatisfaction as shown below:

var searchSatisfactionObj = {
  "event": "_searchSatisfaction",
  "properties": {
    "key": "imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0V1S58",
    "email": "user1@demo.searchstax.com",
    "score": 10,
    "comments": "Very good search experience",
    "_vid": "d7cc372a-2be6-ee1e-26e8-0f903fa36e67"
  }
}
Parameter Description Example
key:
required
string		 Unique Analytics API Key. ‘imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0V1S58’
session:
required
string		 The ID of the web session or mobile application session. ‘qqMKt4fxhcud0T5c3UJ5spgug’
email:
optional
string		 Email ID of the user submitting the feedback ‘user123@demo.searchstax.com’
comments:
optional
string		 Feedback about the search experience as a comment ‘Very good search experience’
score:
required
string		 0-10 score, rating the search experience 10
_vid:
required
string		 Unique Identifier for the visitor “d7cc372a-2be6-ee1e-26e8-0f903fa36e67”

To call the REST API and insert the event, the event object should be encoded to Base64 and passed as the data, just like for the _search event

DATA = urlEncode(base64encode(searchSatisfactionObj))
curl -v "https://analytics-us.searchstax.com/api/v2/track/?data=$DATA"

The above method returns an HTTP status code of 201/204 if the event was successfully added.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Tracking API (REST) appeared first on SearchStax Docs.

]]> Analytics Cookies https://demo.searchstax.com/docs/searchstudio/analytics-cookies/ Thu, 13 Feb 2025 15:41:12 +0000 https://demo.searchstax.com/docs/?post_type=searchstudio&p=20607 Site Search Cookie Usage SearchStax Site Search Analytics uses cookies to track the user’s search behavior. Site Search Analytics uses the following cookies: Name Purpose ms_visitorid This cookie is used… Continue reading Analytics Cookies

The post Analytics Cookies appeared first on SearchStax Docs.

]]> Site Search Cookie Usage

SearchStax Site Search Analytics uses cookies to track the user’s search behavior. Site Search Analytics uses the following cookies:

NamePurpose
ms_visitoridThis cookie is used to identify a user/visitor uniquely.
searchstax_session_idThis cookie is used to uniquely identify a user session. In an  older toolkit (Legacy Vue2 accelerator), this cookie was named searchcookie).

The post Analytics Cookies appeared first on SearchStax Docs.

]]> Tracking API (Javascript) https://demo.searchstax.com/docs/searchstudio/searchstax-studio-javascript-tracking-api/ Mon, 29 Mar 2021 16:25:00 +0000 https://site-qa.searchstax.com/knowledgecenter/?post_type=site_search&p=7901 Analytics Javascript Tracking API This page describes how to add the SearchStax Site Search solution’s Analytics Events to the Javascript of your search page. This is a required step for… Continue reading Tracking API (Javascript)

The post Tracking API (Javascript) appeared first on SearchStax Docs.

]]> Analytics Javascript Tracking API

This page describes how to add the SearchStax Site Search solution’s Analytics Events to the Javascript of your search page. This is a required step for tracking user events. The events, in turn, make it possible to test the effect of proposed changes to your site.

Contents of this page:

Javascript Library

Your search page would track searches, clicks, and user feedback and send the information to your Search App.

Paste the following script in the head section of your Search Page:

 <script type="text/javascript">
    var _msq = _msq || []; //declare object
    var analyticsBaseUrl = 'https://app.searchstax.com';
    var 
    (function () {
      var ms = document.createElement("script");
      ms.type = "text/javascript";
      ms.src = "https://static.searchstax.com/studio-js/v3/js/studio-analytics.js";
      var s = document.getElementsByTagName("script")[0];
      s.parentNode.insertBefore(ms, s);
    })();
 </script>

Change the 'analyticsBaseUrl' based on the Analytics Endpoint shown in on Site Search > App Settings > All APIs > Analytics.

  

Events

An “event” is a user action on your search page, such as searching for a keyword or clicking on a search result. SearchStax supports the following event messages:

An event message is a wrapper for a list of property-value pairs. The values are the data that SearchStax tracks and analyzes.

Each type of event has its own set of required properties, which are detailed below. The following are the common properties across all events:

Parameter Description Example
key:
required
string  		 This is the unique analytics app key as shown in the “Analytics API” tab of your App within Search App Management ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6’
session:
required
string  		 The ID of the web session or mobile application session. If omitted, some analytics features cannot be fully reported. ‘XDJFNS355FGDFVVDFG’

  

The “search” and “related-search” events are intended to be used in the following fashion:

  1. Your search page sends a query to the search API. The search results are returned. A track event fires to track the impressions from the search results.
  2. If using the related searches features, your search page sends a request to the related searches API to get related searches for the query. The related searches are returned. A trackRelatedSearch event fires to track the related searches that were returned
  3. If the user clicks on a document, a trackClick event fires to track which document was clicked on.
  4. If the user clicks on a related search, a trackRelatedSearchClick event fires to track which related search was clicked on.

  

Track Searches and Impressions

To track searches, use _msq.push() and dispatch a track event as part of parsing the response document.

_msq.push(['track', { 
   key: "4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i", 
   user: "smith123", 
   session: "XDJFNS355FGDFVVDFG", 
   query: "sitecore plugin", 
   shownHits: 10, 
   totalHits: 1890, 
   latency: 150, 
   pageNo: 1, 
   impressions: impressions,
   language: "en"
}]);
Parameter Description Example
key:
required
string		 Unique Analytics API Key ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘XDJFNS355FGDFVVDFG’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore plugin’
shownHits:
optional
number		 The number of hits shown in the response document. 10
totalHits:
optional
number		 The number of hits in the index, from the response document.

Note: To track searches that returned no results, set totalHits to 0.

 1890
latency:
optional
number		 The number of milliseconds to execute a search. You define the semantics. (One possibility is to use Qtime from the response document). Without this value, Analytics will not calculate average latency. 150
pageNo:
optional
number		 The page number of the displayed results, from the response document. 1
impressions:
optional
array		 An array of dictionaries, each describing a search result “impression.” This is required if you would like to track impressions. See the example below.
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

The optional array of impression dictionaries lets the Analytics App track the documents that were displayed to the user as search results, whether the user clicked on them or not. Use a javascript array to catalog the search results in the following format:

var impressions = [
   {'cDocId': 'aDocId1', 'cDocTitle': 'aDocTitle1', 'position': 1},
   {'cDocId': 'aDocId2', 'cDocTitle': 'aDocTitle2', 'position': 2},
];

where aDocId1 is the ID of the document in position 1 and aDocTitle1 is the title of the document in position 1. The position parameter is the absolute position of the document in the full result list. (If we’re showing ten items per page, the first result on the fifth page is in position 41.)

For example, your application might respond to a query by (1) passing the query to Solr, (2) parsing the result document, and (3) generating a search-page update containing a script like this one at the end of the <body> section:

<script>
    var track = {
    "key": "imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0",
    "query": "sitecore",
    "shownHits": 3,
    "totalHits": 12,
    "pageNo": 1,
    "latency": 1,
    "session": "Ll5UDHUQHccphnlb7lp6sQIo5",
    "language": "en",
    "impressions": [
      {"cDocId": "https://www.searchstax.com/videos/solr-cloud-best-practices-sitecore/",
        "cDocTitle": "Sitecore Solr Best Practices - SolrCloud SUGLA Meetup | SearchStax",
        "position": 1
      },
      {
        "cDocId": "https://www.searchstax.com/solutions/sitecore-solr/",
        "cDocTitle": "Sitecore Solr Search: Get fast and relevant search results | SearchStax",
        "position": 2
      },
      {
        "cDocId": "https://www.searchstax.com/case-studies/sitecore-solr-search-azure-isango/",
        "cDocTitle": "Case Study Isango!",
        "position": 3
      }
    ],
  }}
    if(track.query != '') {
        _msq.push(['track', track]);
}
</script>

In this way, your application can push a description of the search to your Analytics App by automatically calling the _msq.push() function as soon as the updated search page is viewed by the user.

  

  

  

To track related searches, use _msq.push() and dispatch a trackRelatedSearch event as part of parsing the response document.

_msq.push(['trackRelatedSearch', { 
   key: "4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i", 
   user: "smith123", 
   session: "XDJFNS355FGDFVVDFG", 
   query: "sitecore plugin", 
   shownHits: 10, 
   latency: 150, 
   impressions: impressions,
   language: "en"
   
}]);
Parameter Description Example
key:
required
string		 Unique Analytics API Key ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘XDJFNS355FGDFVVDFG’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore plugin’
shownHits:
optional
number		 The number of hits shown in the response document. 10
latency:
optional
number		 The number of milliseconds to execute a search. You define the semantics. (One possibility is to use Qtime from the response document). Without this value, Analytics will not calculate average latency. 150
impressions:
optional
array		 An array of dictionaries, each describing a search result “impression.” This is required if you would like to track impressions. See the example below.
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

The optional array of impression dictionaries lets the Analytics App track the related searches that were displayed to the user as related search results, whether the user clicked on them or not. Use a javascript array to catalog the related search results in the following format

var impressions = [
   {'relatedSearch': 'relatedTerm1', 'position': 1},
   {'relatedSearch': 'relatedTerm2', 'position': 2},
];

where relatedTerm1 is the returned related search term in position 1.

  

  

Track Clicks

To start generating data around click-through events, search quality and relevance, have _msq.push() send trackClick events to the Analytics App.

In your search-results page, add an on-click event in the link to each search result.

_msq.push(['trackClick', { 
   session: 'Ll5UDHUQHccphnlb7lp6sQIo5', 
   key: 'imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0', 
   query: 'sitecore', 
   position: 2, 
   cDocId: 'https://www.searchstax.com/solutions/sitecore-solr/', 
   cDocTitle: 'Sitecore Solr Search: Get fast and relevant search results | SearchStax', 
   pageNo: 1, 
   shownHits: 3, 
   totalHits: 12,
   language: "en"
}]);
Parameter Description Example
key:
required
string		 Unique Analytics API Key ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘XDJFNS355FGDFVVDFG’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore plugin’
cDocId:
required
string		 The document ID from the response document. ‘https://www.searchstax.com/solutions/sitecore-solr/‘
cDocTitle
required
string		 The document title from the response document. Note: In some applications, the document title may change. Analytics can be calculated as long as cDocID remains constant. ‘Sitecore Solr Search: Get fast and relevant search results | SearchStax’
position:
required
number		 Absolute position of the document in the full list of results. If we’re showing ten items per page, the first result on the 5th page is position in position 41. First item on the first page has position as 1 41
pageNo:
optional
number		 The page number of the displayed results, from the response document. 1
pageUrl:
optional
string		 The URL of the page that is sending the tracking request ‘https://searchstudio.searchstax.com/search’
shownHits:
optional
number		 The number of hits shown in the response document. 10
totalHits:
optional
number		 The number of hits in the index, from the response document. 1890
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

 

  

To start generating data around click-through events, search quality and relevance, have _msq.push() send trackRelatedSearchClick events to the Analytics App.

In your search-results page, add an on-click event in the link to each search result.

_msq.push(['trackRelatedSearchClick', { 
   session: 'Ll5UDHUQHccphnlb7lp6sQIo5', 
   key: 'imDMrs56aTaDJc6jihDejUkDZYj3Gm8riJHlR0', 
   query: 'sitecore', 
   position: 2, 
   relatedSearch: 'sitecore 7', 
   pageNo: 1, 
   shownHits: 3, 
   totalHits: 12,
   language: "en"
}]);
Parameter Description Example
key:
required
string		 Unique Analytics API Key ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i’
user:
optional
string		 A token identifying the webpage user. This datum is stored but is not currently used. ‘smith123’
session:
required
string		 The ID of the web session or mobile application session. ‘XDJFNS355FGDFVVDFG’
query:
required
string		 The query string from your search page, or q from the response document. ‘sitecore plugin’
position:
required
number		 Absolute position of the related search in the full list of results. If we’re showing ten related searches per page, the first related search on the 5th page is position in position 41. First related search on the first page has position as 1 41
relatedSearch:
required
string		 The related search term that was clicked on. ‘sitecore 7’
pageNo:
optional
number		 The page number of the displayed results, from the response document. 1
pageUrl:
optional
string		 The URL of the page that is sending the tracking request ‘https://searchstudio.searchstax.com/search’
shownHits:
optional
number		 The number of hits shown in the response document. 10
totalHits:
optional
number		 The number of hits in the index, from the response document. 1890
language:
optional
string		 A two-letter language code. Defaults to the default language. “en”, “fr”, or “es”

  

 

  

Track Search Satisfaction

SearchStax provides the ability to collect qualitative feedback about the search experience using trackSearchSatisfaction.

_msq.push(['trackSearchSatisfaction', {
    key: '4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i',
    email: 'user1@demo.searchstax.com',
    score: 10,
    comments: 'Very good search experience',
    session: 'XDJFNS355FGDFVVDFG',
    language: 'en'
}]);
Parameter Description Example
key:
required
string		 Unique Analytics API Key. ‘4Qp1Sv9MnALbAGbixW9ZaWrHxpbfwm6i’
session:
required
string		 The ID of the web session or mobile application session. ‘XDJFNS355FGDFVVDFG’
email:
optional
string		 Email ID of the user submitting the feedback ‘user123@demo.searchstax.com’
comments:
optional
string		 Feedback about the search experience as a comment ‘Very good search experience’
score:
required
string		 0-10 score, rating the search experience 10

The searchFeedback events are used to compute the NPS score (Net {Promoter Score) for your Search Application.

  

  

Debugging Analytics APIs

You can use any browser debugging tools to debug the calls being made to the Analytics server. In Chrome, you can right click on the page, click on “Inspect” and look at the Network tab for calls made to the ‘analyticsBaseUrl’. Have ‘Preserve log’ checked so you can track clicks as they open in new pages.

The Analytics APIs will look like:

https://app.searchstax.com/api/v2/track/?data=eyJldmVudCI6Il9zZWFyY2hjbGljayIsInByb3BlcnRpZXMiOnsia2V5IjoiaW1ETXJzNTZhVGFESmM2amloRGVqVWtEWllqM0dtOHJpSkhsUjBWMVM1OCIsInF1ZXJ5Ijoic2l0ZWNvcmUiLCJzaG93bkhpdHMiOjksInRvdGFsSGl0cyI6MTMxLCJwYWdlTm8iOjEsImxhdGVuY3kiOjExLCJzZXNzaW9uIjoiNnNmN09GSWJRSlp1cU92ZU1VdUkyOW5SMSIsImNEb2NJZCI6Imh0dHBzOi8vd3d3LnNlYXJjaHN0YXguY29tL3NvbHV0aW9ucy9zaXRlY29yZS1zb2xyLyIsImNEb2NUaXRsZSI6IlNpdGVjb3JlIFNvbHIgU2VhcmNoOiBHZXQgZmFzdCBhbmQgcmVsZXZhbnQgc2VhcmNoIHJlc3VsdHMgfCBTZWFyY2hTdGF4IiwicG9zaXRpb24iOjEsIl92aWQiOiIxYzkwZWQ3MS1lZjljLTVlNjAtNGJlNS1jODI4OWYwMWJkYzkiLCJ0dCI6MTYxNzA2NjQwODAxMiwicGFnZVVybCI6Imh0dHBzJTNBJTJGJTJGd3d3LnNlYXJjaHN0YXguY29tJTJGc2VhcmNoJTNGc2VhcmNoU3R1ZGlvUXVlcnklM0RzaXRlY29yZSUyNnN0eWxlJTNEdHJ1ZSUyNmZhY2V0cyUzRCUyNnNvcnQlM0QlMjZzdGFydCUzRDAlMjZmYWNldENvbnRlbnQlMjUyMFR5cGUlM0QxJTI2ZmFjZXRBdXRob3IlM0QxJTI2ZmFjZXRLZXl3b3JkcyUzRDEifX0=

The argument to “data” is Base64 encoded properties. You can use online base64 decoders like https://www.base64decode.org/ to decode them to view the JSON data being passed

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Tracking API (Javascript) appeared first on SearchStax Docs.

]]> Reporting API (REST) https://demo.searchstax.com/docs/searchstudio/searchstax-studio-reporting-api-rest/ Fri, 05 Aug 2022 20:27:45 +0000 https://demo.searchstax.com/docs/?post_type=searchstudio&p=12300 Analytics Reporting REST API This page describes how a SearchStax Site Search solution Enterprise Plan client can use the SearchStax® Analytics Tracking REST API to retrieve search events and items from the… Continue reading Reporting API (REST)

The post Reporting API (REST) appeared first on SearchStax Docs.

]]> Analytics Reporting REST API

This page describes how a SearchStax Site Search solution Enterprise Plan client can use the SearchStax® Analytics Tracking REST API to retrieve search events and items from the Search App.

The Tracking REST API can also perform Custom Reports searches.  

Reporting URL and Key

Navigate to the Site Search > App Settings > All APIs > Analytics screen. This screen displays the Analytics Reporting API Endpoint and the Analytics Reporting API Key. The key is used to identify the Search App.

The Analytics Reporting API Endpoint is https://analytics-us.searchstax.com.

Reports

The Analytics Reporting REST API supports the following reporting actions:

Each type of report has its own set of required properties, which are detailed below.

Report Searches

To create a report of Most-Popular Searches, No-Result Searches, and No-Click Searches, use a cURL command in this general format:

curl '<Reporting API Endpoint>/api/rest/analytics/v1/reporting/searches/searches' -H 'authorization: Token <Key>'

A fully-expanded example resembles this:

curl 'https://analytics-us.searchstax.com/api/rest/analytics/v1/reporting/searches/searches?&startDate=2022-02-06T07:00:00&endDate=2022-02-28T06:59:59&offset=0&limit=10&language=en' -H 'authorization: Token 4Qp1Sv9MnALbAGbixW9ZaW95338fwm6i'

Parameter Description Example
key:
required
string		 Unique Analytics Reporting API Key 4Qp1Sv9MnALbAGbixW9ZaW95338fwm6i
startDate:
optional
datetime		 The date and time (UTC) of the earliest events in the report. Defaults to the last 31 days. 2022-02-06T07:00:00
endDate:
optional
string		 The date and time (UTC) of the latest events in the report. Default to the last 31 days. Max end date is 31 days after the start date. 2022-02-28T06:59:59
offset:
optional
number		 This index begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to start collecting in the report. Defaults to 0. 0
limit:
optional
number		 This number begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to end the collection of data in the report.Defaults to the end of the results. 10
language:
optional
string		 A two-letter language code. Defaults to the default language. en

The returned value is a JSON document describing searches. The parameters map into the values shown in the Site Search Searches screen. A partial sample is shown below.

{
  "aggMetrics": [
    {
      "resultSearchCount": 58,
      "totalSearchCount": 61,
      "clickThroughRate": 36.0655737704918,
      "clickCount": 21,
      "sessionCount": 7,
      "sessionWithSearchCount": 6,
      "sessionWithSearchPercent": 85.71428571428571,
      "avgClickPosition": 2.380952380952381,
      "meanReciprocalRank": 0.6373015873015873,
      "noResultSearchCount": 3,
      "noResultSearchPercent": 4.918032786885246,
      "searchWithClickCount": 22,
      "searchExitCount": 1,
      "searchExitPercent": 14.285714285714285,
      "searchPerSessionCount": 8.714285714285714,
      "startDate": "2022-02-06T07:00:00+00:00",
      "endDate": "2022-02-28T06:59:59+00:00"
    }
  ],
  "topNoClickSearches": [
    {
      "searchCount": 6,
      "sumClicks": 0,
      "clickThroughRate": 0,
      "avgLatency": 21.166666666666668,
      "avgHits": 403,
      "query": "search",
      "ofTotal": 9.836065573770492
    },
    {
      "searchCount": 5,
      "sumClicks": 0,
      "clickThroughRate": 0,
      "avgLatency": 121.2,
      "avgHits": 80,
      "query": "drupal",
      "ofTotal": 8.19672131147541
    },
    {
      "searchCount": 5,
      "sumClicks": 0,
      "clickThroughRate": 0,
      "avgLatency": 18.4,
      "avgHits": 173,
      "query": "sitecore plugin",
      "ofTotal": 8.19672131147541
    },

Report Content Items

To create a report of Most-Clicked and Least-Clicked Content Items, use a cURL command in this general format:

curl '<Analytics Reporting API Endpoint>/api/rest/analytics/v1/reporting/clicks/clicks' -H 'authorization: Token <Key>'

A fully-expanded example resembles this:

curl 'https://analytics-us.searchstax.com/api/rest/analytics/v1/reporting/clicks/clicks?&startDate=2022-02-06T07:00:00&endDate=2022-02-28T06:59:59&offset=0&limit=10&language=en' -H 'authorization: Token V3B2XGcj9nmA8cMJiEp5UURb1eZzQMiKL953384dszU'

Parameter Description Example
key:
required
string		 Unique Analytics Reporting API Key 4Qp1Sv9MnALbAGbixW9ZaW95338fwm6i
startDate:
optional
datetime		 The date and time (UTC) of the earliest events in the report. Defaults to the last 31 days. 2022-02-06T07:00:00
endDate:
optional
string		 The date and time (UTC) of the latest events in the report. Default to the last 31 days. Max end date is 31 days after the start date. 2022-02-28T06:59:59
offset:
optional
number		 This index begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to start collecting in the report. Defaults to 0. 0
limit:
optional
number		 This number begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to end the collection of data in the report.Defaults to the end of the results. 10
language:
optional
string		 A two-letter language code. Defaults to the default language. en

The returned value is a JSON document describing items. The parameters map into the values shown in the Site Search Content Items screen. A partial sample is shown below.

{
  "aggMetrics": [
    {
      "impressionCount": 663,
      "clickCount": 21,
      "contentClickThroughRate": 3.167420814479638,
      "avgClickPosition": 2.380952380952381,
      "startDate": "2022-02-06T07:00:00+00:00",
      "endDate": "2022-02-28T06:59:59+00:00"
    }
  ],
  "mostClicked": [
    {
      "clickCount": 1,
      "ofTotal": 4.761904761904762,
      "cDocId": "095c1ffe-d2bb-4bc3-82ae-8c13075e5021",
      "cDocTitle": "Microsoft Azure | SearchStax Partners",
      "impressionCount": 2,
      "contentClickThroughRate": 50,
      "avgClickPosition": 2
    },
    {
      "clickCount": 1,
      "ofTotal": 4.761904761904762,
      "cDocId": "0a13ade1-da89-4a78-9531-50efacfc48b4",
      "cDocTitle": "Sitecore 10.0 - SearchStax Docs",
      "impressionCount": 7,
      "contentClickThroughRate": 14.285714285714285,
      "avgClickPosition": 5
    },
    {
      "clickCount": 1,
      "ofTotal": 4.761904761904762,
      "cDocId": "1115779e-6aa5-456c-bb39-2a372c589bd6",
      "cDocTitle": "Solr Version Policy | SearchStax",
      "impressionCount": 1,
      "contentClickThroughRate": 100,
      "avgClickPosition": 3
    },

Custom Reports (Searches)

To perform a Custom Reports search of Searches using the REST API, use a cURL command in this general format:

curl '<Reporting API Endpoint>/api/rest/analytics/v1/reporting/searches/power-search/searches?&filterName=<Filter Name>&filterOperator=<Filter Operator>&filterValue=<Filter Value>&ordering=<Ordering>' -H 'authorization: Token <Key>'

A fully-expanded example resembles this:

curl 'https://analytics-us.searchstax.com/api/rest/analytics/v1/reporting/searches/power-search/searches?filterName=clickThroughRate&filterOperator=gt&filterValue=3&ordering=-clickThroughRate&startDate=2022-02-06T07:00:00&endDate=2022-02-28T06:59:59&offset=0&limit=10&language=en' -H 'authorization: Token V3B2XGcj9nmA8cMJiEp5UURb1eZzQMiKL953384dszU'

Note that you can use up to three filterName=”name”&filterOperator=”operator”&filterValue=”value” constructions in sequence to apply multiple filters.

Parameter Description Example
key:
required
string		 Unique Analytics Reporting API Key 4Qp1Sv9MnALbAGbixW9ZaW95338fwm6i
filterName:
required
string		 The name of the filter as seen on the Custom Reports screen. clickThroughRate
avgHits
searchCount
sumClicks
avgClickPosition
avgLatency
filterOperator
required
string		 The filter operator to be applied. Must appear between filterName and filterValue. gt
gte
lt
lte
eq
filterValue
required
number		 The value that the filter will test. 50
ordering
required
string		 The results are ordered by the filterName specified. This defaults to sort by ascending. Applying a ‘-’ before the filterName will produce a descending sort. -clickThroughRate
startDate:
optional
datetime		 The date and time (UTC) of the earliest events in the report. Defaults to the last 31 days. 2022-02-06T07:00:00
endDate:
optional
string		 The date and time (UTC) of the latest events in the report. Default to the last 31 days. Max end date is 31 days after the start date. 2022-02-28T06:59:59
offset:
optional
number		 This index begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to start collecting in the report. Defaults to 0. 0
limit:
optional
number		 This number begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to end the collection of data in the report. Defaults to the end of the results. 10
language:
optional
string		 A two-letter language code. Defaults to the default language. en

The returned value is a JSON document describing searches. The parameters map into the values shown in the Site Search Custom Reports screen. A partial sample is shown below.

{
  "results": [
    {
      "searchCount": 1,
      "sumClicks": 3,
      "clickThroughRate": 100,
      "avgLatency": 34,
      "avgHits": 67,
      "query": "partner",
      "ofTotal": 1.639344262295082,
      "avgClickPosition": 2.3333333333333335
    },
    {
      "searchCount": 1,
      "sumClicks": 2,
      "clickThroughRate": 100,
      "avgLatency": 39,
      "avgHits": 35,
      "query": "private",
      "ofTotal": 1.639344262295082,
      "avgClickPosition": 2.5
    },
    {
      "searchCount": 1,
      "sumClicks": 3,
      "clickThroughRate": 100,
      "avgLatency": 69,
      "avgHits": 432,
      "query": "solr",
      "ofTotal": 1.639344262295082,
      "avgClickPosition": 2
    },

Custom Reports (Content Items)

To perform an Custom Reports search of Content Items using the REST API, use a cURL command in this general format:

curl '<Reporting API Endpoint>/api/rest/analytics/v1/reporting/clicks/power-search/clicks?&filterName=<Filter Name>&filterOperator=<Filter Operator>&filterValue=<Filter Value>&ordering=<Ordering>' -H 'authorization: Token <Key>'

A fully-expanded example resembles this:

curl 'https://analytics-us.searchstax.com/api/rest/analytics/v1/reporting/clicks/power-search/clicks?filterName=contentClickThroughRate&filterOperator=lte&filterValue=20&ordering=-contentClickThroughRate&startDate=2022-02-06T07:00:00&endDate=2022-02-28T06:59:59&offset=0&limit=10&language=en' -H 'authorization: Token V3B2XGcj9nmA8cMJiEp5UURb1eZzQMiKL953384dszU'

Note that you can use up to three filterName=”name”&filterOperator=”operator”&filterValue=”value” constructions in sequence to apply multiple filters.

Parameter Description Example
key:
required
string		 Unique Analytics Reporting API Key 4Qp1Sv9MnALbAGbixW9ZaW95338fwm6i
filterName:
required
string		 The name of the filter as seen on the Power Search screen. contentClickThroughRate
impressionCount
clickCount
filterOperator
required
string		 The filter operator to be applied. Must appear between filterName and filterValue. gt
gte
lt
lte
eq
filterValue
required
number		 The value that the filter will test. 50
ordering
required
string		 The results are ordered by the filterName specified. This defaults to sort by ascending. Applying a ‘-’ before the filterName will produce a descending sort. -contentClickThroughRate
startDate:
optional
datetime		 The date and time (UTC) of the earliest events in the report. Defaults to the last 31 days. 2022-02-06T07:00:00
endDate:
optional
string		 The date and time (UTC) of the latest events in the report. Default to the last 31 days. Max end date is 31 days after the start date. 2022-02-28T06:59:59
offset:
optional
number		 This index begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to start collecting in the report. Defaults to 0. 0
limit:
optional
number		 This number begins at 0. It is used for how far down in the results for most popular searches, no result searches, and searches with no clicks tables to end the collection of data in the report. Defaults to the end of the results. 10
language:
optional
string		 A two-letter language code. Defaults to the default language. en

The returned value is a JSON document describing items. The parameters map into the values shown in the Site Search Custom Reports screen. A partial sample is shown below.

{
  "results": [
    {
      "clickCount": 1,
      "ofTotal": 4.761904761904762,
      "cDocId": "0a13ade1-da89-4a78-9531-50efacfc48b4",
      "cDocTitle": "Sitecore 10.0 - SearchStax Docs",
      "impressionCount": 7,
      "contentClickThroughRate": 14.285714285714285,
      "avgClickPosition": 5
    },
    {
      "clickCount": 1,
      "ofTotal": 4.761904761904762,
      "cDocId": "4e33c9c8-008a-43f9-bc08-85f8fc5e68c0",
      "cDocTitle": "Free Disk Space - SearchStax Docs",
      "impressionCount": 7,
      "contentClickThroughRate": 14.285714285714285,
      "avgClickPosition": 1
    },
    {
      "clickCount": 1,
      "ofTotal": 4.761904761904762,
      "cDocId": "6289d367-00f2-4817-8659-00a5b0172ad3",
      "cDocTitle": "Sitecore Archives - SearchStax Docs",
      "impressionCount": 18,
      "contentClickThroughRate": 5.555555555555555,
      "avgClickPosition": 1
    },

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Reporting API (REST) appeared first on SearchStax Docs.

]]> Related Searches API https://demo.searchstax.com/docs/searchstudio/related-searches-api/ Tue, 21 Dec 2021 20:32:14 +0000 https://demo.searchstax.com/docs/?post_type=searchstudio&p=10430 Related Searches API The SearchStax Site Search solution provides an API that retrieves the Related Searches defined for a specific search phrase in the Search App. Related Searches allows users… Continue reading Related Searches API

The post Related Searches API appeared first on SearchStax Docs.

]]> Related Searches API

The SearchStax Site Search solution provides an API that retrieves the Related Searches defined for a specific search phrase in the Search App.

Related Searches allows users to manually define Search terms that are related, and augments them from search terms learned using Artificial Intelligence using Analytics data. For the AI augmented related searches, Analytics should be connected with your Search page and there should be enough searches with clicks available.

This page describes how to retrieve a Json document of related-search strings for display on your search page.

The API can be accessed through any tool that assembles HTTP requests and dispatch them to a server. Among these would be the Python coreapi package, the Postman tool, and cURL. For Windows, use PowerShell 7.

Symbols enclosed in carets (< and >) such as <username> are metavariables. Substitute your local values when you encounter them in the examples.

Related Search

This method returns a list of Related Searches from a Search App.

GET &lt;related-searches-URL>?search=&lt;search-phrase>

where <related-searches-URL> is an endpoint from the Discovery API Tab of the App Settings screen, and <search-phrase> is the base query that has related searches defined on the Related Searches screen.

This method uses SearchAPIKey authorization. The Search API key is displayed on the Discovery API Tab. It must be passed in the header of the request.

When invoked from Linux (Bash script):

URL="https://app.searchstax.com/api/v1/nn/related-search/"
APIKEY="456cwe54sasb8e5lu5y6k48j55u95338slas"
KEYWORD="sitecore"

SEARCHES=$(curl -H "Authorization: $APIKEY" "$URL?search=$KEYWORD")

When invoked from Windows Powershell:

# Removes TLS obstacles from connection. Otherwise connections fail. 
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12

$URL = "https://app.searchstax.com/api/v1/nn/related-search/"
$APIKEY = "81c09977fedb7e89310c87df81d7bc787301155e"
$KEYWORD = "Sitecore"

# Set up HTTP header for authorization token
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Authorization", $APIKEY)

$RESPONSE = Invoke-RestMethod -Method Get -ContentType 'application/json' -Headers $headers `
              -uri $($URL+"?search=$KEYWORD") 
$RESPONSE = $RESPONSE | ConvertTo-Json -Depth 3

Write-Host $RESPONSE

The response is a JSON document containing a list of related searches.

{
  "responseHeader": {
    "zkConnected": true,
    "status": 0,
    "QTime": 0
  },
  "response": {
    "numFound": 5,
    "start": 0,
    "numFoundExact": true,
    "docs": [
      {
        "search_term": "sitecore",
        "related_search": "sitecore 10",
        "related_score": 1
      },
      {
        "search_term": "sitecore",
        "related_search": "sitecore plugin",
        "related_score": 1
      },
      {
        "search_term": "sitecore",
        "related_search": "sitecore replace azure",
        "related_score": 1
      },
      {
        "search_term": "sitecore",
        "related_search": "site search for sitecore",
        "related_score": 1
      },
      {
        "search_term": "sitecore",
        "related_search": "managed solr for sitecore",
        "related_score": 1
      }
    ]
  }
}

The fields of each related search have the following meanings:

  • search_term: This is the search string that keys to the Related Searches.
  • related_search: Each entry contains the string of a single Related Search.
  • related_score: A measure of similarity to the search_term. The range of values is 0 to 1. Higher values are more similar.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Related Searches API appeared first on SearchStax Docs.

]]> Ingest API https://demo.searchstax.com/docs/searchstudio/searchstax-studio-ingest-api/ Mon, 10 Jan 2022 20:41:10 +0000 https://demo.searchstax.com/docs/?post_type=searchstudio&p=10481 Ingest API Site Search > App Settings > Data Management > Ingest API The SearchStax Site Search solution’s Ingest API exposes the project’s /update endpoint. It lets you update Solr… Continue reading Ingest API

The post Ingest API appeared first on SearchStax Docs.

]]> Ingest API

Site Search > App Settings > Data Management > Ingest API

The SearchStax Site Search solution’s Ingest API exposes the project’s /update endpoint. It lets you update Solr documents in your Site Search project. For perspective on the advantages of using the Ingest API, see our Data Ingestion for Site Search blog post.

The /update endpoint uses the “Read-Write” Search API credentials from the Site Search > App Settings > All APIs > Search & Indexing screen.

  

Contents:

  

Indexing JSON Documents

For indexing a single JSON document, pass the JSON document to the /update endpoint as shown below:

For apps using Token Authentication:

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:application/json' --data-binary '{"id":"1"}' "https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

For app using Basic Authentication:

curl -X POST -H 'Content-Type: application/json' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update/json/docs' --user app40-admin:REDACTEDPWD --data-binary '
{
  "id": "1",
  "title": "Doc 1"
}'

Adding multiple documents can be done by passing an array of JSON objects to the /update endpoint as shown below

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:application/json' --data-binary '[{"id":"1","title_t":"Test Title","description_t":"Testing","group_s":"Token"}]' "https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

curl -X POST -H 'Content-Type: application/json' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update' --user app40-admin:REDACTEDPWD --data-binary '
[
  {
    "id": "1",
    "title": "Doc 1"
  },
  {
    "id": "2",
    "title": "Doc 2"
  }
]'

If the data is in a JSON file and contains an array of JSON objects, you can make a call to the /update endpoint as shown below

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:application/json' --data-binary @example.json "https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

curl -X POST -H 'Content-Type: application/json' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update' --user app40-admin:REDACTEDPWD --data-binary @example.json -H 'Content-type:application/json'
  

Indexing XML Documents

To index XML documents, you can send one or multiple <add> tags to the \update request as shown below:

For apps using Token Authentication:

curl -H "Authorization: Token b70dacf3956e6e148393fbfREDACTED" -X POST -H 'Content-type:text/xml' --data-binary 
 '&lt;add>
    &lt;doc>
      &lt;field name="id">id1&lt;/field>
      &lt;field name="title">Document1&lt;/field>
      &lt;field name="text">This is the first document&lt;/field>
    &lt;/doc>
  &lt;/add>' 
"https://searchcloud-2-us-east-1.searchstax.com/12345/custom-1234/update?commit=true"

For apps using Basic Authentication:

curl -X POST -H 'Content-Type: text/xml' 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/update?commit=true' --user app40-admin:REDACTEDPWD --data-binary '
&lt;add>
  &lt;doc>
    &lt;field name="id">id1&lt;/field>
    &lt;field name="title">Document1&lt;/field>
    &lt;field name="text">This is the first document&lt;/field>
   &lt;/doc>
&lt;/add>'
  • The <add> element introduces one more documents to be added. This can be substituted by <update> to update the document.
  • The <doc> element introduces the fields making up a document.
  • The <field> element presents the content for a specific field.
  

Indexing CSV Documents

The /update endpoint can load data files in comma-separated format (CSV). The format of the data file is very simple, as shown in the books.csv example that is distributed with Solr stand-alone installation files:

id,cat,name,price,inStock,author,series_t,sequence_i,genre_s
0553573403,book,A Game of Thrones,7.99,true,George R.R. Martin,"A Song of Ice and Fire",1,fantasy
0553579908,book,A Clash of Kings,7.99,true,George R.R. Martin,"A Song of Ice and Fire",2,fantasy
055357342X,book,A Storm of Swords,7.99,true,George R.R. Martin,"A Song of Ice and Fire",3,fantasy
0553293354,book,Foundation,7.99,true,Isaac Asimov,Foundation Novels,1,scifi
0812521390,book,The Black Company,6.99,false,Glen Cook,The Chronicles of The Black Company,1,fantasy
0812550706,book,Ender's Game,6.99,true,Orson Scott Card,Ender,1,scifi
0441385532,book,Jhereg,7.95,false,Steven Brust,Vlad Taltos,1,fantasy
0380014300,book,Nine Princes In Amber,6.99,true,Roger Zelazny,the Chronicles of Amber,1,fantasy
0805080481,book,The Book of Three,5.99,true,Lloyd Alexander,The Chronicles of Prydain,1,fantasy
080508049X,book,The Black Cauldron,5.99,true,Lloyd Alexander,The Chronicles of Prydain,2,fantasy
  • Line 1 is the header, containing the field names used in the index. One of these must be a unique document ID.
  • Subsequent lines each represent one index record. Commas separate values. Do not allow spaces immediately following a comma.
  • A missing value is denoted by two adjacent commas (,,).
  • Note the dynamic fields (series_t, sequence_i, genre_s) in the header. This mechanism lets you add custom fields to your index without the labor of modifying the Solr schema.

For apps using Token Authentication:

curl -H "Authorization: Token 8a931ae9bfe3538c2b4d8121fad564c676f7de0f" 
  -H 'Content-type:application/csv'
  --data-binary @books.csv
  'https://searchcloud-1-us-west-2.searchstax.com/95338/csvuploadapp-3684/update?commit=true

For apps using Basic Authentication:

curl -H 'Content-type:application/csv'
  --data-binary @books.csv
  --user app40-admin:REDACTEDPWD
  'https://searchcloud-1-us-west-2.searchstax.com/95338/csvuploadapp-3684/update?commit=true

Deleting Documents

When experimenting with document uploads, it is often helpful to be able to clear the index or to remove specific documents. See the following Help Center topics for examples:

  

API Limits

  • All update requests should have a maximum size of 2048KB.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Ingest API appeared first on SearchStax Docs.

]]> Overview https://demo.searchstax.com/docs/searchstudio/api-documentation-overview/ Mon, 22 May 2023 22:47:28 +0000 https://demo.searchstax.com/docs/?post_type=searchstudio&p=15520 Site Search API Overview The SearchStax Site Search solution includes a number of APIs to streamline and seamlessly accelerate the implementation process. Questions? Do not hesitate to contact the SearchStax… Continue reading Overview

The post Overview appeared first on SearchStax Docs.

]]> Site Search API Overview

The SearchStax Site Search solution includes a number of APIs to streamline and seamlessly accelerate the implementation process.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Overview appeared first on SearchStax Docs.

]]> Search API https://demo.searchstax.com/docs/searchstudio/searchstax-studio-search-api/ Mon, 29 Mar 2021 23:10:25 +0000 https://site-qa.searchstax.com/docs/?post_type=site_search&p=8334 Search API The SearchStax Site Search solution’s Search API lets you request basic and advanced search results from you Search App. The Search Endpoint (/emselect) for your Search App is… Continue reading Search API

The post Search API appeared first on SearchStax Docs.

]]> Search API

The SearchStax Site Search solution’s Search API lets you request basic and advanced search results from you Search App.

The Search Endpoint (/emselect) for your Search App is available within your Search API Tab page as shown below:

Your Search endpoints are protected using Token Authentication or Basic Authentication in certain circumstances. When using the endpoints for search, it is recommended to use the Read Only Credentials.

This is a cURL example illustrating Token Authentication with a simple query:

curl -H "Authorization: Token e3y545ere45gff654nnhf651ng5d15g1g6" --request GET 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/12345/testexample-12/emselect?q=*:*'

This is a cURL example illustrating Basic Authentication with a simple query:

curl -u 'app40-api:paSSw0Rd' --request GET 'https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/<search-app-name>/emselect?q=*:*'

Contents of this page:

Authentication

Token Authentication

For apps using Token Authentication, the Access Tokens are cryptographically secure 20 bytes tokens that do not expire, but can be rotated.

Token Management

You can manage your tokens and rotate them if needed.

  1. Click on the Create Token button – this will create an enabled Read Only token by default.
  2. If you need to change an access right for a token, select the appropriate access right in the dropdown.
  3. Leave the old token enabled until ready to rotate.
  4. Once ready, disable the token by clicking on the toggle (turning it to red) or delete the token.

*If you are rotating your token, the new token will need to be deployed out through your dev process as well.

Basic Authentication

For apps using Basic Authentication, the Search APIs are protected using a sets of an auto-generated User-IDs and passwords set by the user.

You may change the passwords (but not the user IDs) on this screen. Click the Save button when finished.

For performing basic search, simply pass the query as the 'q' parameter as shown below:

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;language=en

This returns the search results as configured by your Search App for your default model as shown below:

{
  "responseHeader":{
    "zkConnected":true,
    "status":0,
    "QTime":13,
    "params":{
      "hl.fragsize":"200",
      "q":"sitecore",
      "language":"en",
      "spellcheck.correct":"true",
      "echoParams":"all",
      "wt":"json",
      "rows":"12",
      "hl":"true",
      "hl.snippets":"3",
      "facet":"true",
      "fl":"title,author_name,meta_image,paths,content_type,meta_description,meta_modified_time,meta_published_time,date,exif_date,metaproducts_ss,[elevated],url",
      "facet.field":["content_type_facet",
        "meta_keywords_facet",
        "metaproducts_ss",
        "metaplatforms_ss",
        "metaindustries_ss",
        "metalocations_ss"],
      "f.content_type_facet.facet.limit":"7",
      "f.content_type_facet.facet.mincount":"1",
      "f.content_type_facet.facet.sort":"count",
      "f.meta_keywords_facet.facet.limit":"5",
      "f.meta_keywords_facet.facet.mincount":"1",
      "f.meta_keywords_facet.facet.sort":"count",
      "f.metaproducts_ss.facet.limit":"3",
      "f.metaproducts_ss.facet.mincount":"1",
      "f.metaproducts_ss.facet.sort":"count",
      "f.metaplatforms_ss.facet.limit":"5",
      "f.metaplatforms_ss.facet.mincount":"1",
      "f.metaplatforms_ss.facet.sort":"count",
      "f.metaindustries_ss.facet.limit":"5",
      "f.metaindustries_ss.facet.mincount":"1",
      "f.metaindustries_ss.facet.sort":"count",
      "f.metalocations_ss.facet.limit":"5",
      "f.metalocations_ss.facet.mincount":"1",
      "f.metalocations_ss.facet.sort":"count",
      "defType":"edismax",
      "qf":"title^69.0 meta_description^82.0 content^100.0 meta_keywords url author_name meta_keywords_facet content_type_facet meta_published_time",
      "uniqueId":"url",
      "bf":"recip(ms(NOW,date),3.16e-11,10,1)^38.0",
      "spellcheck.q":"sitecore",
      "spellcheck.accuracy":"0.9",
      "spellcheck.extendedResults":"true",
      "spellcheck":"on",
      "spellcheck.dictionary":"searchstudioSpell_studio_spellcheck_data_en_en",
      "spellcheck.count":"1",
      "spellcheck.collate":"true",
      "spellcheck.onlyMorePopular":"true",
      "fq":"-document_type:\"xml\" AND -url:\"docs/category\""}},
  "spellcheck":{
    "suggestions":[],
    "collations":[],
    "correctlySpelled":true},
  "externalLinks":[{
      "name":"Resurgence of Search ",
      "description":"In this white paper, you’ll learn about the search challenges facing companies as they head into digital transformation projects. But, prioritizing search is not enough. Getting to market quickly enough to stay competitive, keeping up with the dynamic nature of changes and keeping users engaged are also critical factors. Discover the 4 Pillars for Modernizing Search and learn how our customers are innovating with site search transformation.",
      "url":"https://www.searchstax.com/white-papers/resurgence-of-search-white-paper/"}],
  "response":{"numFound":680,"start":0,"docs":[
      {
        "title":["Hosted Solr Service for Sitecore | SearchStax"],
        "url":"https://www.searchstax.com/solutions/sitecore-solr/",
        "meta_description":["SearchStax Cloud is the hosted Solr solution for Sitecore and offers an easy, reliable, performant and scalable Solr service."],
        "date":"2023-10-23T19:02:39Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/03/Managed-Solr-Soltuion-for-Sitecore.png"],
        "paths":["solutions / sitecore-solr"],
        "meta_modified_time":["2023-09-20T07:08:59Z"],
        "content_type":["Webpage"],
        "exif_date":["2023-10-23T19:02:34Z"],
        "[elevated]":true},
      {
        "title":["Site Search Tool for Sitecore | SearchStax"],
        "url":"https://www.searchstax.com/searchstudio/sitecore/",
        "meta_description":["Get personalized site search for Sitecore. Understand user behavior with analytics &amp; optimize Sitecore site search with easy-to-use tools."],
        "date":"2023-10-23T19:02:35Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/03/Sites-Search-for-Sitecore.png"],
        "paths":["searchstudio / sitecore"],
        "meta_modified_time":["2023-09-04T09:55:34Z"],
        "content_type":["Webpage"],
        "exif_date":["2023-10-23T19:02:30Z"],
        "[elevated]":true},
      {
        "title":["Sitecore Relies on SearchStax Cloud | SearchStax Blog"],
        "url":"https://www.searchstax.com/blog/sitecore-relies-on-searchstax-managed-solr/",
        "meta_description":["In our latest Case Study, see how Sitecore implements SearchStax Cloud to get a more stable, secure and robust Solr environment for their website.In our latest Customer Case Study, see how Sitecore implements SearchStax Managed Solr to get a more stable, secure and robust Solr environment to support their website. Editor’s Note: Managed"],
        "author_name":"Tom Humbarger",
        "date":"2023-10-23T19:01:33Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/02/Sitecore-Relies-on-SearchStax-Managed-Solr-1536x864-1.jpg"],
        "paths":["blog / sitecore-relies-on-searchstax-managed-solr"],
        "metaproducts_ss":["SearchStax Cloud"],
        "meta_modified_time":["2023-07-31T09:59:37Z"],
        "meta_published_time":["2021-08-16T21:24:00Z"],
        "content_type":["Blog"],
        "exif_date":["2023-10-23T19:01:29Z"],
        "[elevated]":true},
      {
        "title":["Penn Foster Selects SearchStax Studio | SearchStax Blog"],
        "url":"https://www.searchstax.com/blog/penn-foster-selects-searchstax-site-search/",
        "meta_description":["Penn Foster selected SearchStax Studio to replace their existing website search function and improve their search experience.Search Workforce development pioneer Penn Foster has selected SearchStax Studio to replace the existing search function on Penn Foster’s website as announced in a press release on April 9, 2021. Editor’s"],
        "author_name":"Tom Humbarger",
        "date":"2023-10-23T19:01:04Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/02/Penn-Foster-Selects-SearchStax-Site-Search-1536x864-1.png"],
        "paths":["blog / penn-foster-selects-searchstax-site-search"],
        "meta_modified_time":["2023-07-31T10:10:00Z"],
        "meta_published_time":["2021-04-19T23:47:00Z"],
        "content_type":["Blog"],
        "exif_date":["2023-10-23T19:01:04Z"],
        "[elevated]":true},
      {
        "title":["SearchStax Solr Plugin Supports Sitecore 10.2 | SearchStax Blog"],
        "url":"https://www.searchstax.com/blog/searchstax-solr-plugin-now-supports-sitecore-10-2/",
        "meta_description":["The SearchStax Solr Plugin for Sitecore now supports Sitecore 10.2 to save hours of time and effort for companies running Sitecore websites.We are pleased to announce that SearchStax has added Sitecore 10.2 support for our Sitecore Solr Plugin. The Sitecore Solr Plugin accelerates the process and automates a number of manual"],
        "author_name":"Dipsy Kapoor",
        "date":"2023-10-23T19:01:26Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2021/07/10.2-solr-plugin.png"],
        "paths":["blog / searchstax-solr-plugin-now-supports-sitecore-10-2"],
        "metaproducts_ss":["SearchStax Cloud"],
        "meta_modified_time":["2023-07-31T09:07:21Z"],
        "meta_published_time":["2021-12-02T16:18:00Z"],
        "content_type":["Blog"],
        "exif_date":["2023-10-23T19:01:20Z"],
        "[elevated]":false},
      {
        "title":["SearchStax Cloud Connector for Sitecore Now Supports Sitecore 10.3 | SearchStax Blog"],
        "url":"https://www.searchstax.com/blog/cloud-connector-for-sitecore-now-supports-sitecore-10-3/",
        "meta_description":["The SearchStax Cloud Connector for Sitecore now supports Sitecore 10.3 which accelerates implementation of SearchStax Cloud.We are pleased to announce that SearchStax has added Sitecore 10.3 support for our SearchStax Cloud Connector for Sitecore."],
        "author_name":"Thomas DiLascio",
        "date":"2023-10-23T19:00:39Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/03/SearchStax-Cloud-Connector-Now-Supports-Sitecore-10.3.png"],
        "paths":["blog / cloud-connector-for-sitecore-now-supports-sitecore-10-3"],
        "metaproducts_ss":["SearchStax Cloud"],
        "meta_modified_time":["2023-07-31T06:34:13Z"],
        "meta_published_time":["2023-03-07T17:31:28Z"],
        "content_type":["Blog"],
        "exif_date":["2023-10-23T19:00:39Z"],
        "[elevated]":false},
      {
        "title":["Sitecore Solr Plugin Support for Sitecore 9.3 | SearchStax Blog"],
        "url":"https://www.searchstax.com/blog/sitecore-solr-plugin-support-for-sitecore-9-3/",
        "meta_description":["To support the Sitecore community, we are announcing further enhancements to the Sitecore Solr Plugin to make connecting Solr to Sitecore deployments equally easy. Making Solr Setup in Sitecore Easier You probably already know that SearchStax makes it easy to deploy, manage and scale highly available Solr. To better support the Sitecore community, we"],
        "author_name":"Karan Jeet Singh",
        "date":"2023-10-23T19:01:34Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/01/The-Sitecore-Solr-Plugin-Makes-Setup-Easy-mhoppsy-on-pixabay-apple-3595520_1920.jpg"],
        "paths":["blog / sitecore-solr-plugin-support-for-sitecore-9-3"],
        "meta_modified_time":["2023-07-31T10:31:01Z"],
        "meta_published_time":["2020-04-07T04:16:00Z"],
        "content_type":["Blog"],
        "exif_date":["2023-10-23T19:01:28Z"],
        "[elevated]":false},
      {
        "title":["SearchStax Cloud Connector for Sitecore - Videos | SearchStax"],
        "url":"https://www.searchstax.com/videos/demo-of-sitecore-plugin-for-managed-solr/",
        "meta_description":["Watch a short demo of the SearchStax Cloud Connector for Sitecore. The Connector accelerates installation of hosted Solr for Sitecore.Connect SearchStax Cloud hosted Solr to Sitecore in minutes. The Sitecore Solr Plugin accelerates the process and automates a number of manual tasks involved with connecting a Sitecore installation to a SearchStax Solr instance. Setting up Solr  on Sitecore with the Plugin will save hours of time and effort."],
        "date":"2023-10-23T19:02:41Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2022/04/Cloud-Sitecore-Connector-title-logo.png"],
        "paths":["videos / demo-of-sitecore-plugin-for-managed-solr"],
        "metaproducts_ss":["SearchStax Cloud"],
        "meta_modified_time":["2023-03-07T23:59:58Z"],
        "content_type":["Video"],
        "exif_date":["2023-10-23T19:02:39Z"],
        "[elevated]":false},
      {
        "title":["Sitecore 10.0 - SearchStax Docs"],
        "url":"https://demo.searchstax.com/docs/searchstax-cloud-connector-for-sitecore-10-0-solr/",
        "meta_description":["Connect SearchStax Cloud to Sitecore 10.0 using a PowerShell 7 script that automates the steps for integrating Solr with Sitecore."],
        "author_name":"admin",
        "date":"2023-10-23T23:01:12Z",
        "meta_image":["https://demo.searchstax.com/docs/wp-content/uploads/2021/03/downloadSitecoreSingle100.png"],
        "paths":["docs / searchstax-cloud-connector-for-sitecore-10-0-solr"],
        "meta_modified_time":["2023-09-29T15:49:03Z"],
        "meta_published_time":["2021-03-03T05:47:33Z"],
        "content_type":["Documentation"],
        "exif_date":["2023-10-23T23:01:08Z"],
        "[elevated]":false},
      {
        "title":["TechGuilds | SearchStax Partners"],
        "url":"https://www.searchstax.com/partner/techguilds/",
        "meta_description":["TechGuilds is a SearchStax Alliance Member and solves the toughest problems for Sitecore customers and Sitecore Technology Partners."],
        "date":"2023-10-23T19:02:26Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/04/tech-guilds-logo.png"],
        "paths":["partner / techguilds"],
        "meta_modified_time":["2023-04-24T06:50:04Z"],
        "content_type":["Webpage"],
        "exif_date":["2023-10-23T19:02:22Z"],
        "[elevated]":false},
      {
        "title":["Horizontal | SearchStax Partners"],
        "url":"https://www.searchstax.com/partner/horizontal/",
        "meta_description":["Horizontal is a SearchStax Alliance Member and solves the toughest problems for Sitecore customers and Sitecore Technology Partners."],
        "date":"2023-10-23T19:02:18Z",
        "meta_image":["https://www.searchstax.com/wp-content/uploads/2023/04/horizontal-logo.png"],
        "paths":["partner / horizontal"],
        "meta_modified_time":["2023-04-24T06:49:40Z"],
        "content_type":["Webpage"],
        "exif_date":["2023-10-23T19:02:13Z"],
        "[elevated]":false},
      {
        "title":["Optimizing the xConnect Search Service - SearchStax Docs"],
        "url":"https://demo.searchstax.com/docs/hc/optimizing-the-xconnect-search-service/",
        "meta_description":["When using Solr as the search provider for Sitecore, there are a variety of Sitecore settings that can be tuned to improve performance. Symptoms might include high memory consumption by Sitecore services, slow average response times for the xConnect."],
        "date":"2023-10-23T23:00:45Z",
        "meta_image":["https://demo.searchstax.com/docs/wp-content/uploads/2023/03/faq-1.png"],
        "paths":["docs / hc / optimizing-the-xconnect-search-service"],
        "meta_modified_time":["2023-04-28T21:05:47Z"],
        "content_type":["Documentation"],
        "exif_date":["2023-10-23T23:00:45Z"],
        "[elevated]":false}]
  },
  "facet_counts":{
    "facet_queries":{},
    "facet_fields":{
      "content_type_facet":[
        "Documentation",337,
        "Blog",164,
        "Webpage",116,
        "Video",27,
        "Case Study",22,
        "White Paper",8,
        "Podcasts",6],
      "meta_keywords_facet":[],
      "metaproducts_ss":[
        "SearchStax Cloud",87,
        "SearchStax Studio",57,
        "SearchStax Cloud, SearchStax Studio",12],
      "metaplatforms_ss":[
        "Sitecore",57,
        "Drupal",19,
        "AEM",3,
        "Acquia",3,
        "Custom",3],
      "metaindustries_ss":[
        "Technology",10,
        "Higher Education",5,
        "Healthcare",4,
        "Financial Services",3,
        "Construction",2],
      "metalocations_ss":[
        "North America",30,
        "EMEA",15,
        "Australia",2,
        "North America, EMEA",1,
        "North America, EMEA, South America",1]},
    "facet_ranges":{},
    "facet_intervals":{},
    "facet_heatmaps":{}},
  "highlighting":{
    "https://www.searchstax.com/solutions/sitecore-solr/":{
      "meta_description":["SearchStax Cloud is the hosted Solr solution for &lt;em>Sitecore&lt;/em> and offers an easy, reliable, performant and scalable Solr service."],
      "title":["Hosted Solr Service for &lt;em>Sitecore&lt;/em> | SearchStax"],
      "content":["Hosted Solr Service for &lt;em>Sitecore&lt;/em> | SearchStax Skip to content Products Solutions Pricing Customers Partners Resources Sign in Schedule A Demo Sign-in Products SearchStax Cloud Highly-Available, Fast",
        " Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers Corporate",
        " Websites Pricing Customers Partners Resources Resources for Helpful Information Blog Case Studies Documentation White Paper Videos Support Podcasts All Resources &lt;em>sitecore&lt;/em> | SOLUTIONS search infrastructure"]},
    "https://www.searchstax.com/searchstudio/sitecore/":{
      "meta_description":["Get personalized site search for &lt;em>Sitecore&lt;/em>. Understand user behavior with analytics &amp; optimize &lt;em>Sitecore&lt;/em> site search with easy-to-use tools."],
      "title":["Site Search Tool for &lt;em>Sitecore&lt;/em> | SearchStax"],
      "content":["Site Search Tool for &lt;em>Sitecore&lt;/em> | SearchStax Skip to content Products Solutions Pricing Customers Partners Resources Sign in Schedule A Demo Sign-in Products SearchStax Cloud Highly-Available, Fast and",
        " Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers Corporate",
        " Websites Pricing Customers Partners Resources Resources for Helpful Information Blog Case Studies Documentation White Paper Videos Support Podcasts All Resources &lt;em>Sitecore&lt;/em> | SOLUTIONS site search made easy"]},
    "https://www.searchstax.com/blog/sitecore-relies-on-searchstax-managed-solr/":{
      "meta_description":["In our latest Case Study, see how &lt;em>Sitecore&lt;/em> implements SearchStax Cloud to get a more stable, secure and robust Solr environment for their website.In our latest Customer Case Study, see how &lt;em>Sitecore&lt;/em>"],
      "title":["&lt;em>Sitecore&lt;/em> Relies on SearchStax Cloud | SearchStax Blog"],
      "content":["&lt;em>Sitecore&lt;/em> Relies on SearchStax Cloud | SearchStax Blog Skip to content Products Solutions Pricing Customers Partners Resources Sign in Schedule A Demo Sign-in Products SearchStax Cloud Highly",
        " Cloud Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers",
        " Corporate Websites Pricing Customers Partners Resources Resources for Helpful Information Blog Case Studies Documentation White Paper Videos Support Podcasts All Resources Home / Case Study / &lt;em>Sitecore&lt;/em> Relies"]},
    "https://www.searchstax.com/blog/penn-foster-selects-searchstax-site-search/":{
      "content":[" Cloud Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers",
        " seemed like an impossible task. Penn Foster was already using SearchStax Cloud, SearchStax’s managed Solr solution, to manage the Solr search infrastructure for their &lt;em>Sitecore&lt;/em>-based website.  When",
        " Foster decided to go with the SearchStax Site Search technology. According to Chad Smith who leads the front-end development for Penn Foster’s web properties on &lt;em>Sitecore&lt;/em> and .NET, the top four reasons"]},
    "https://www.searchstax.com/blog/searchstax-solr-plugin-now-supports-sitecore-10-2/":{
      "meta_description":["The SearchStax Solr Plugin for &lt;em>Sitecore&lt;/em> now supports &lt;em>Sitecore&lt;/em> 10.2 to save hours of time and effort for companies running &lt;em>Sitecore&lt;/em> websites.We are pleased to announce that SearchStax has added",
        " &lt;em>Sitecore&lt;/em> 10.2 support for our &lt;em>Sitecore&lt;/em> Solr Plugin. The &lt;em>Sitecore&lt;/em> Solr Plugin accelerates the process and automates a number of manual"],
      "title":["SearchStax Solr Plugin Supports &lt;em>Sitecore&lt;/em> 10.2 | SearchStax Blog"],
      "content":["SearchStax Solr Plugin Supports &lt;em>Sitecore&lt;/em> 10.2 | SearchStax Blog Skip to content Products Solutions Pricing Customers Partners Resources Sign in Schedule A Demo Sign-in Products SearchStax Cloud",
        " Infrastructure Cloud Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare",
        " / SearchStax Solr Plugin Now Supports &lt;em>Sitecore&lt;/em> 10.2 SearchStax Solr Plugin Now Supports &lt;em>Sitecore&lt;/em> 10.2 We are pleased to announce that SearchStax has added &lt;em>Sitecore&lt;/em> 10.2 support for our &lt;em>Sitecore&lt;/em> Solr Plugin"]},
    "https://www.searchstax.com/blog/cloud-connector-for-sitecore-now-supports-sitecore-10-3/":{
      "meta_description":["The SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em> now supports &lt;em>Sitecore&lt;/em> 10.3 which accelerates implementation of SearchStax Cloud.We are pleased to announce that SearchStax has added &lt;em>Sitecore&lt;/em> 10.3 support",
        " for our SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em>."],
      "title":["SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em> Now Supports &lt;em>Sitecore&lt;/em> 10.3 | SearchStax Blog"],
      "content":["SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em> Now Supports &lt;em>Sitecore&lt;/em> 10.3 | SearchStax Blog Skip to content Products Solutions Pricing Customers Partners Resources Sign in Schedule A Demo Sign-in Products",
        " Solutions Solr Infrastructure Cloud Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher",
        " SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em> Now Supports &lt;em>Sitecore&lt;/em> 10.3 Best Practices SearchStax Cloud &lt;em>Sitecore&lt;/em> Solr Development March 07, 2023 Thomas DiLascio | 3 min. read We are pleased to announce"]},
    "https://www.searchstax.com/blog/sitecore-solr-plugin-support-for-sitecore-9-3/":{
      "meta_description":["To support the &lt;em>Sitecore&lt;/em> community, we are announcing further enhancements to the &lt;em>Sitecore&lt;/em> Solr Plugin to make connecting Solr to &lt;em>Sitecore&lt;/em> deployments equally easy. Making Solr Setup in &lt;em>Sitecore&lt;/em>",
        " Easier You probably already know that SearchStax makes it easy to deploy, manage and scale highly available Solr. To better support the &lt;em>Sitecore&lt;/em> community, we"],
      "title":["&lt;em>Sitecore&lt;/em> Solr Plugin Support for &lt;em>Sitecore&lt;/em> 9.3 | SearchStax Blog"],
      "content":["&lt;em>Sitecore&lt;/em> Solr Plugin Support for &lt;em>Sitecore&lt;/em> 9.3 | SearchStax Blog Skip to content Products Solutions Pricing Customers Partners Resources Sign in Schedule A Demo Sign-in Products SearchStax Cloud",
        " Infrastructure Cloud Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare",
        " Providers Corporate Websites Pricing Customers Partners Resources Resources for Helpful Information Blog Case Studies Documentation White Paper Videos Support Podcasts All Resources Home / &lt;em>Sitecore&lt;/em> / &lt;em>Sitecore&lt;/em>"]},
    "https://www.searchstax.com/videos/demo-of-sitecore-plugin-for-managed-solr/":{
      "meta_description":["Watch a short demo of the SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em>. The Connector accelerates installation of hosted Solr for Sitecore.Connect SearchStax Cloud hosted Solr to &lt;em>Sitecore&lt;/em> in minutes",
        ". The &lt;em>Sitecore&lt;/em> Solr Plugin accelerates the process and automates a number of manual tasks involved with connecting a &lt;em>Sitecore&lt;/em> installation to a SearchStax Solr instance. Setting up Solr  on &lt;em>Sitecore&lt;/em>"],
      "title":["SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em> - Videos | SearchStax"],
      "content":["SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em> - Videos | SearchStax Skip to content Products Solutions Pricing Customers Partners Resources Sign in Schedule A Demo Sign-in Products SearchStax Cloud Highly",
        " Cloud Providers Amazon Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers",
        " to &lt;em>Sitecore&lt;/em> in Minutes Watch this short video of how to connect &lt;em>Sitecore&lt;/em> to Solr using the SearchStax Cloud Connector for &lt;em>Sitecore&lt;/em>. The Cloud Connector accelerates the process and automates a number of manual"]},
    "https://demo.searchstax.com/docs/searchstax-cloud-connector-for-sitecore-10-0-solr/":{
      "meta_description":["Connect SearchStax Cloud to &lt;em>Sitecore&lt;/em> 10.0 using a PowerShell 7 script that automates the steps for integrating Solr with &lt;em>Sitecore&lt;/em>."],
      "title":["&lt;em>Sitecore&lt;/em> 10.0 - SearchStax Docs"],
      "content":["&lt;em>Sitecore&lt;/em> 10.0 - SearchStax Docs Cloud Docs Studio Docs Help Center Support Contact Us Sign-In SearchStax Cloud SearchStax Cloud Documentation Dedicated Managed Solr Integrate Solr With... &lt;em>Sitecore&lt;/em>",
        " &lt;em>Sitecore&lt;/em> 10.0 Filters Cloud Docs Studio Docs Help Center Support Contact Us Sign-In Search Free Trial Sign-In Cloud Docs Home How to File a Support Ticket Free Trial Overview Serverless Solr Getting Started",
        " Dedicated Managed Solr Getting Started Dedicated Deployments Dedicated Quick Start Integrate Solr With... Integration Overview Drupal Drupal 7 Drupal 8 Haystack Haystack &lt;em>Sitecore&lt;/em> &lt;em>Sitecore&lt;/em> FAQ &lt;em>Sitecore&lt;/em>/Solr"]},
    "https://www.searchstax.com/partner/techguilds/":{
      "meta_description":["TechGuilds is a SearchStax Alliance Member and solves the toughest problems for &lt;em>Sitecore&lt;/em> customers and &lt;em>Sitecore&lt;/em> Technology Partners."],
      "content":[" Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers Corporate Websites",
        ". Proudly Canadian, based in Toronto, we have the honor of working with great clients, many of whom have been with us since we began in 2014! Our Services TechGuilds Super Care™ Finally, &lt;em>Sitecore&lt;/em> peace",
        " of mind Digital Experience Strategy &amp; Design Craft experiences that delight users and grow your business &lt;em>Sitecore&lt;/em> Implementation A hassle-free approach that delivers excellence &lt;em>Sitecore&lt;/em> Support Sleep"]},
    "https://www.searchstax.com/partner/horizontal/":{
      "meta_description":["Horizontal is a SearchStax Alliance Member and solves the toughest problems for &lt;em>Sitecore&lt;/em> customers and &lt;em>Sitecore&lt;/em> Technology Partners."],
      "content":[" Web Services Microsoft Azure Google Cloud CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Site Search CMS Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers Corporate Websites",
        " Services Microsoft Azure Google Cloud Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe close Site Search Platforms &lt;em>Sitecore&lt;/em> Drupal Adobe Acquia Industries Higher Education Healthcare Providers Corporate Websites Resources"]},
    "https://demo.searchstax.com/docs/hc/optimizing-the-xconnect-search-service/":{
      "meta_description":["When using Solr as the search provider for &lt;em>Sitecore&lt;/em>, there are a variety of &lt;em>Sitecore&lt;/em> settings that can be tuned to improve performance. Symptoms might include high memory consumption by &lt;em>Sitecore&lt;/em>"],
      "content":[" Do Solr Backups Fail? &lt;em>Sitecore&lt;/em> Connection Errors Can't Connect to Solr or Zookeeper Indexing Errors 301 Error 400 Error 401 Error 403 Error 404 Error 413 Error 413 Maximum Post Size Exceeded 414 Error",
        " Postgres or MongoDB? Identical Queries Produce Inconsistent Results &lt;em>Sitecore&lt;/em> Solr Topics Can SearchStax provide Solr indexing to &lt;em>Sitecore&lt;/em>? Optimizing the xConnect Search Service Lowering &amp;rows=1000000 Can we",
        " use Sitecore's SwitchOnRebuild with SearchStax? Unpublish/Delete Fails to Remove Item from &lt;em>Sitecore&lt;/em> Index &lt;em>Sitecore&lt;/em> Connection Errors Why does &lt;em>Sitecore&lt;/em> fail to populate schemas? Solr Backups Backup Best"]}},
  "metadata":{
    "facets":[{
        "name":"content_type_facet",
        "label":"Content Type"},
      {
        "name":"meta_keywords_facet",
        "label":"Keywords"},
      {
        "name":"metaproducts_ss",
        "label":"Product"},
      {
        "name":"metaplatforms_ss",
        "label":"Platforms"},
      {
        "name":"metaindustries_ss",
        "label":"Industry"},
      {
        "name":"metalocations_ss",
        "label":"Location"}],
    "results":[{
        "name":"title",
        "title":"Title",
        "result_card":"title"},
      {
        "name":"author_name",
        "title":"",
        "result_card":""},
      {
        "name":"meta_image",
        "title":"Image",
        "result_card":""},
      {
        "name":"paths",
        "title":"",
        "result_card":"paths"},
      {
        "name":"content_type",
        "title":"Content Type",
        "result_card":"ribbon"},
      {
        "name":"meta_description",
        "title":"Meta Description",
        "result_card":"description"},
      {
        "name":"meta_modified_time",
        "title":"Meta Modified Time",
        "result_card":""},
      {
        "name":"meta_published_time",
        "title":"Meta Publish Time",
        "result_card":"date"},
      {
        "name":"date",
        "title":"",
        "result_card":"thumbnail"},
      {
        "name":"exif_date",
        "title":"",
        "result_card":""},
      {
        "name":"metaproducts_ss",
        "title":"",
        "result_card":"url"}],
    "sorts":[{
        "id":1204,
        "name":"date",
        "order":"desc",
        "label":"Newest Content"},
      {
        "id":1205,
        "name":"date",
        "order":"asc",
        "label":"Oldest Content"}]}}
  1. responseHeader.params gives details of all parameters passed to the search request, including responseHeader.params.rows which gives the number of documents returned in the response
  2. externalLinks If the query is a Trigger for an External Promotion, the externalLinks element will appear as a list at the same level as the response element. Your page-rendering code will have to detect it and retrieve the individual External Promotions from the list.
  3. response.numFound gives the total number of documents that matched the query
  4. response.start gives zero starting index of the search results
  5. response.docs contains the documents that matched the query. It includes all fields that were selected during Result Configuration inside the Search App. It also always include the field that is marked as the “uniqueKey” in the schema, which is most cases is either "id" or "url"; and [elevated] which marks whether the result document is a “promoted/sponsored” item or a regular search result.
  6. facet_counts.facet_fields contains dynamically generated Facet name as counts. The Facets returned are configured from the Search App. For each facet, the response contains the value of the facet, and a count of the number of documents that have that facet value.
  7. highlighting gives the highlighted content if Search highlighting is selected in the Search App. It is organized by the unique id of the document
  8. spellcheck contains spelling suggestions

SearchStax uses the eDisMax query parser and supports the standard Solr query Syntax. Some query examples are:

  1. Get documents matching “sitecore plugin”, not necessarily together or containing both words – https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore plugin
  2. Get documents matching “sitecore plugin” as a phrase (Phrase Query) – https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q="sitecore plugin“
  3. Get documents where “sitecore” and “plugin” are within 20 words of each other (Proximity Query) – https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q="sitecore plugin“~20
  4. Get documents containing words starting with site (Wildcard Query) – https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=site*
  

Language

If your Search App is configured for multiple languages, use the language parameter, providing the 2-digit code for the language. If omitted, this defaults to the default language. Example for Spanish (es):

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;language=es

If your dataset contains different documents for different languages in the same app, you might have to also add filter criteria to filter the results to only that language. You can do that as shown below in the example, or by using Data Filters in the app settings for the language. Example:

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;language=es&amp;fq=language_s:"es_ES"
  

Pagination

start and rows parameters control the pagination. start is zero based index of the search results and rows is the number of results to return per page. Example:

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;start=4&amp;rows=4

gives the second page of search results, if you are getting 4 results per page. The format of the result is the same as Basic Search.

  

Sorting

You can use the sort parameter to specify the field by which you would like to sort the search results. If the parameter is omitted, by default, the search results are sorted by relevance. Below are some examples showing sorting

  • Sort by Date Descending
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;sort=date%20desc
  • Sort by Date Ascending
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;sort=date%20asc
  • Sort by title Ascending
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;sort=title%20asc
  

Faceting / Facet Selection

In the search results facet_counts.facet_fields contains all the facets. To apply a facet and narrow down the search results, the fq parameter is used.

  • Add a facet on content_type, selecting Blog
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;fq=content_type:"blog"
  • Add 2 facets: To add multiple facets, simply pass multiple fq parameters
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;fq=content_type:"blog"&amp;fq=author_name:"John Adams"

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;fq=content_type:"blog"&amp;fq=author_name:("John Adams" OR "Jane Doe")

  

Spelling Suggestions

If a user misspells the search term, and a corresponding correction can be detected, spellcheck.suggestions will contain the spelling suggestions. Example: 

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecole

gives back:

{
  "responseHeader":{..},
  "response":{"numFound":0,"start":0,"docs":[]
  },
  "facet_counts":{},
  "highlighting":{},
  "spellcheck":{
    "suggestions":[
      "sitecole",{
        "numFound":1,
        "startOffset":0,
        "endOffset":8,
        "suggestion":["sitecore"]}],
    "correctlySpelled":false},
  "metadata":{..}
}
  

There are two methods to apply Spell Check suggestions to a user:

1 .

Only provide a Suggestion: Results are displayed for the user’s original misspelled search input with a “Did you mean [suggested spelling]?” path. With this method, you do not need to add any special parameters to the API.

 

2 .

  • Autocorrection: The user’s original misspelled search input is autocorrected and results are displayed for the spell check suggestion returned with a “Search instead for [original search input]?” path. With this method, the parameter `spellcheck.correct` can be used. Example
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=searchstaz&amp;spellcheck.correct=true

When using the autocorrection method, there are two additional responseHeader.params:

  1. originalQ that contains the original query, searchstaz
  2. autoCorrectedQ that contains searchstax and is an indicator that the user’s query was misspelled and autocorrected to this value.
  

The spellcheck component is configured to return back 1 spelling suggestion. To retrieve more spelling suggestions, the parameter `spellcheck.count` can be used. Example

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecole&amp;spellcheck.count=4

If you would like no spelling suggestions offered when there are any documents matching the query, pass spellcheck.maxResultsForSuggest=1

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecole&amp;spellcheck.count=4&amp;spellcheck.maxResultsForSuggest=1
  

Advance Search API Options

  • metadata: emselect endpoint returns additional metadata that can be useful for the User Interface. If you would not like that to be returned, you can pass ‘metadata=false’ to the API. Example:
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;metadata=false
  • flAdditional: You should select the list of fields to be returned from the Search App. However, if you would like to add additional fields to the results, you can pass them as the flAdditional parameter. Example: 
https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;flAdditional=geodist(),score

  

Personalization / Search using different models

Site Search allows you to configure multiple Search Profiles. These could be used for an experiment, or to provide personalized search results. For instance, you could configure your custom search page to show one model on first use, but switch to another on subsequent searches or visits.

To use a particular model, pass the model name as the model parameter. If no model is specified or the model name that is specified does not exist, the search engine uses what is specified as the “default” model in the Search App.

Example: If you have a model named ‘experimentA’ you can pass it as shown below:

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-SearchStudioCorpSite/emselect?q=sitecore&amp;model=experimentA

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Search API appeared first on SearchStax Docs.

]]> Auto-Suggest API https://demo.searchstax.com/docs/searchstudio/searchstax-studio-auto-suggest-api/ Wed, 31 Mar 2021 15:37:21 +0000 https://site-qa.searchstax.com/docs/?post_type=site_search&p=8405 Auto-Suggest API The SearchStax Site Search solution’s Auto-Suggest URL is available on the Search API tab. This endpoint provides suggestions to search users. The Autosuggest Endpoint for your App is… Continue reading Auto-Suggest API

The post Auto-Suggest API appeared first on SearchStax Docs.

]]> Auto-Suggest API

The SearchStax Site Search solution’s Auto-Suggest URL is available on the Search API tab. This endpoint provides suggestions to search users.

The Autosuggest Endpoint for your App is available within your App Settings page as shown below:

As your users enter characters, you can call this endpoint to get suggestions for search queries.

Example: As a user starts typing si, you can call:

https://ss123456-cvrfzabx-us-east-1-aws.searchstax.com/solr/ss123456-CORPSITE-suggester-1/emsuggest?q=si&amp;language=en

to get all suggestions for “si” as shown below:

{
  "responseHeader": {
    "zkConnected": true,
    "status": 0,
    "QTime": 0,
    "params": {
      "q": "si",
      "language": "en",
      "suggest.minPrefixChars": "2",
      "echoParams": "all",
      "suggest.count": "6",
      "suggest": "true",
      "suggest.dictionary": "suggester1",
      "wt": "json"
    }
  },
  "suggest": {
    "suggester1": {
      "si": {
        "numFound": 2,
        "suggestions": [
          {
            "term": "&lt;b>si&lt;/b>tecore",
            "weight": 100,
            "payload": ""
          },
          {
            "term": "&lt;b>si&lt;/b>te search",
            "weight": 100,
            "payload": ""
          }
        ]
      }
    }
  }
}

You can see all suggestions, along with their weights under suggest.<suggestername>.<enteredCharacters>

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Auto-Suggest API appeared first on SearchStax Docs.

]]>