User Documentation Archives - SearchStax Docs Documentation Thu, 16 Nov 2023 17:46:14 +0000 en-US hourly 1 https://wordpress.org/?v=6.4.2 https://www.searchstax.com/docs/wp-content/uploads/2023/10/cropped-favicon-32x32.png User Documentation Archives - SearchStax Docs 32 32 Overview https://www.searchstax.com/docs/searchstudio/search-experience-overview/ Mon, 22 May 2023 21:08:59 +0000 https://www.searchstax.com/docs/?post_type=searchstudio&p=15490 Search Experience Overview Studio > Search Experience > Overview SearchStax Studio has an easy-to-use interface for updating, enhancing and managing the site search experience for your website. Questions or Need… Continue reading Overview

The post Overview appeared first on SearchStax Docs.

]]>
Search Experience Overview

Studio > Search Experience > Overview


SearchStax Studio has an easy-to-use interface for updating, enhancing and managing the site search experience for your website.

  • Results Configuration – lets you manage the fields that will be displayed in your search results, select your search facets and define the options for sorting search results
  • Basic Relevance – provides an interface to manage stopwords, synonyms and spellcheck for your search experience
  • Relevance Modeling – lets you define a Relevance Model to set up the behavior of your search experience using the following features:
    • Search Fields – identify the fields that will be used to determine the search results
    • Global Filters – create Include and Exclude filters to partition your index and focus your search results on relevant results
    • Ranking – use the sliders to determine which fields or calculated fields are emphasized in the search results
    • Rules – modify the search results with Rules to finetune the search results
    • Promotions – create internal or external promotions to ‘promote’ specific content to the top of the search results and shape a better search experience for your users

Questions or Need Support?

Do not hesitate to contact the SearchStax Support Desk.

The post Overview appeared first on SearchStax Docs.

]]>
Overview https://www.searchstax.com/docs/searchstudio/analytics-overview/ Mon, 22 May 2023 18:28:57 +0000 https://www.searchstax.com/docs/?post_type=searchstudio&p=15478 Analytics & Insights Overview Studio > Analytics > Overview One of the key benefits of SearchStax Studio is the robust site search analytics provided by the application. Explore the detailed… Continue reading Overview

The post Overview appeared first on SearchStax Docs.

]]>
Analytics & Insights Overview

Studio > Analytics > Overview


One of the key benefits of SearchStax Studio is the robust site search analytics provided by the application. Explore the detailed pages below to learn more about the site search analytics in Studio:

  • Dashboard – the Site Search Analytics Dashboard is the starting point for understanding what is going on with search for your website
  • Searches – the Searches page provides high level analytics for searches on your website and then lets you dive into the the top searches, no result searches and searches with no clicks
  • Items – the Items page delivers insights around the content that was searched on your website including top level statistics for Total Impressions, Clicks and Click-Through Rate and then a listing of the Most Clicked and Least Clicked Content
  • Power Search – Power Search lets you create your own custom reports around Searches or Content, and then provides a way to export the reports as a .CSV file
  • Search Feedback – the Search Feedback page summarizes the user feedback ratings and comments if you are using the Feedback Widget on your search page
  • Analytics Glossary – the Analytics Glossary is a listing of the terms and definitions used by SearchStax Studio

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Overview appeared first on SearchStax Docs.

]]>
Dashboard https://www.searchstax.com/docs/searchstudio/searchstax-studio-dashboard/ Mon, 08 Mar 2021 07:52:00 +0000 https://site-qa.searchstax.com/knowledgecenter/?post_type=site_search&p=7708 SearchStax Studio Dashboard Studio > Analytics > Dashboard Analytics – Dashboard is the landing page for entering the SearchStax Studio. It displays summary statistics for the selected Search App. To… Continue reading Dashboard

The post Dashboard appeared first on SearchStax Docs.

]]>
SearchStax Studio Dashboard

Studio > Analytics > Dashboard


Analytics – Dashboard is the landing page for entering the SearchStax Studio. It displays summary statistics for the selected Search App. To select an App, pull down the menu in the navigation bar on the left margin of the screen.

The summary statistics are relative to the date range. There are several predefined ranges plus a custom Date Range option.

The Date Range presents a calendar display where you can select a starting date, navigate to another month if necessary, and select an ending date. Click Apply to refresh the Dashboard.

Note that the Search App retains user data for a limited time dependent on your Product Plan. In a live system, new analytics data is recorded in a constant stream. The new events usually appear on the Dashboard within an hour of posting, but there are situations where a 24-hour delay can occur.

During the last month, this selected App recorded over 579 searches, and 160 searches with click-through events. Roughly 27% of the searches ended with a clicked item.

 

Average search latency (time between request and response) was 8.5 ms, which was a 6% decrease from the previous month. Decreased latency is a good sign, so the percent increase figure is highlighted in green. (Bad news is red.)

Farther down on the same screen are graphs depicting various measures of search success.

  • Average Click Position: The average position of clicked items in the search results over a specific time interval (one month in the illustration). We would like to see this trending downward, meaning that the selected result was getting closer to the top of the list.
  • Click-Through Rate: Click-through events divided by number of searches in a specific time interval, expressed as a percent. We would like to see this trending upward, meaning that users are finding more items of interest.
  • No Results Searches: Percent of total searches that produced zero results over a specific time period. We would like to see this trend downward. Adjust suggestions, improve spelling correction, add synonyms, or create new content to improve.

At the bottom of the page is a graph depicting the activity around Related Searches.

  • Total Searches: All searches logged during the selected time interval.
  • Searches with Related Searches: Number of total searches that offered at least one Related Search.
  • Related Searches with Clicks: Number of Related Searches that were launched by the search user.
  • Related Searches Click-Through Rate: “Related Searches with Clicks” divided by “Searches with Related Searches” x 100.

See our Analytics Glossary for a list of all SearchStax Studio metrics.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Dashboard appeared first on SearchStax Docs.

]]>
Searches https://www.searchstax.com/docs/searchstudio/searchstax-studio-searches/ Mon, 08 Mar 2021 20:35:00 +0000 https://site-qa.searchstax.com/knowledgecenter/?post_type=site_search&p=7710 Searches Studio > Analytics > Searches The searches statistics table summarizes the user actions that the Search App has accumulated over the selected time period.  Scroll down a screen to… Continue reading Searches

The post Searches appeared first on SearchStax Docs.

]]>
Searches

Studio > Analytics > Searches


The searches statistics table summarizes the user actions that the Search App has accumulated over the selected time period. 

  • Total Sessions: Total search sessions during the selected time period.
  • Total Searches: There can be multiple searches per session.
  • Searches per Session: Total Searches divided by Total Sessions.
  • % Search Exits: Percent of sessions that ended from the search page.
  • Searches with Clicks: Number of searches that ended with a click-through event.
  • Click-Through Rate: Percent of Total Searches that ended in a click-through event.
  • Average Click Position: Average of the positions of the items that were clicked in the list of results.
  • % No Results: Percent of Total Searches that produced zero results.
  • MRR: Mean Reciprocal Rank. The average of 1/Click Position for all click-through events. It normalizes the score to the range 0 to 1, with 1 being best.

Scroll down a screen to find a table of the keywords used in the most popular searches recorded during the time interval. 

  • Searches: Keywords typed into the search field.
  • Search Count: Number of times this term was submitted in the designated time interval.
  • Of Total: Percent of all searches in the time interval that used this keyword.

Click on an item to see results what users eventually selected. 

The summary statistics across the top of the page are:

  • Total Searches: Total Number of Search Requests in the selected time interval. These include searches with results and searches with no results
  • Total Searches with Clicks: Total Number of Searches with at least one click on a result item.
  • Total Clicks: Total Number of clicks on the Search Results that were shown to the user
  • Click-through Rate: The percentage of tracked searches that generated at least one click on a result. Mathematically it is (Number of searches with at least 1 click / Total Searches) * 100
  • Average Click Position: Average of the positions of the impressions that were clicked in the list of results

The Search Details display tells us that six users typed in “disaster recovery.” Of those, four users clicked on one of the results. 

  • Item Title: The title of a document that users clicked after searching for the keyword.
  • Impression Count: The number of times that this item was presented to users in search results.
  • Average Click Position: Average position of this item when users selected it.
  • Click Count: Number of times users clicked this item.
  • Click Through Rate: Percent of clicks divided by Impression Count.

Use the browser’s “back” button to return to the Analytics – Search page. Scroll down another screen to view the list of keywords that were used in No Result Searches. (Users looked for something that isn’t in your index.)

SearchStax SearchStudio

Scroll down one more screen to view the list of searches that produced results, but the user didn’t click on anything. 

SearchStax SearchStudio

See our Analytics Glossary for a list of all SearchStax Studio metrics.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Searches appeared first on SearchStax Docs.

]]>
Items https://www.searchstax.com/docs/searchstudio/searchstax-studio-items/ Mon, 08 Mar 2021 20:40:00 +0000 https://site-qa.searchstax.com/knowledgecenter/?post_type=site_search&p=7711 Items Studio > Analytics > Items The Analytics – Items screen presents insights on the content that mattered most, least, and that did not interest the viewer. It shows lists… Continue reading Items

The post Items appeared first on SearchStax Docs.

]]>
Items

Studio > Analytics > Items


The Analytics – Items screen presents insights on the content that mattered most, least, and that did not interest the viewer. It shows lists of ranked result-items, and lets you click through to see the searches that led to each item. 

  • Total Impressions: Number of result items displayed during the selected time interval.
  • Total Clicks: Number of click-through events in the selected time interval.
  • Items Click-Through Rate: Percentage of Total Impressions that received a click-through event.

The Most Clicked table shows the result items that were clicked the most. 

  • Item Title: The title of a document that users clicked on during the selected time interval.
  • Impression Count: The number of times that this item was presented to users in search results during the selected time interval.
  • Click Count: Number of click-through events for this item in the selected time interval.
  • Item Click-Through Rate: Percent of Impressions that were clicked on.

You can click on any item to see the Item Details view. 

  • Total Searches: Number of searches in this time period that matched this item.
  • Total Impressions: Number of times the item was presented to users in the results list.
  • Total Clicks: Number of click-through events on this item.
  • Item Click-Through Rate: Percent of Impressions that received a click-through event.

Use the “back” button to return to the Analytics – Items screen. Scroll down to view the list of “Least Clicked,” meaning content items that had little or no engagement. 

See our Analytics Glossary for a list of all SearchStax Studio metrics.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Items appeared first on SearchStax Docs.

]]>
Power Search https://www.searchstax.com/docs/searchstudio/serchstax-studio-power-search/ Mon, 08 Mar 2021 20:55:09 +0000 https://site-qa.searchstax.com/knowledgecenter/?post_type=site_search&p=7712 Power Search Studio > Analytics > Power Search A Search App is a database that collects user search events from your search page. The Analytics – Power Search screen lets… Continue reading Power Search

The post Power Search appeared first on SearchStax Docs.

]]>
Power Search

Studio > Analytics > Power Search


A Search App is a database that collects user search events from your search page. The Analytics – Power Search screen lets you filter this collection of keywords and content items. You can set up filters using the drop-down fields at the top of the screen. After selecting a time period, you can search for either Searches (keywords) or Items.

For Searches, we can filter for six search-related metrics. The form offers six inequality tests and a number input field.

 

  • Search Count: Number of searches in the selected time period that used this keyword.
  • Hits: Number of items that match this search.
  • Click Count: Number of click-through events resulting from these searches.
  • Average Click Position: Average position of the result item that received a click-through event.
  • Click-Through Rate: Percent of searches that received a click-through event.
  • Latency: Average time to process a search.

For Items, we can filter for three metrics:

  • Impression Count: Number of times this item was presented to users as a search result.
  • Click Count: Number of times a user clicked on this item.
  • Item Click-Through Rate: Percent of Impressions that received a click-through event.

At the far right of the line are two buttons:    The (+) button lets us apply multiple filters simultaneously. The search button (magnifying glass) executes the current search. 

A successful search produces a table of keywords or items. Note that you can sort the table by column, which opens up some powerful insights into the data. You can also Export the table as a .CSV file.

You can click-through to a Search Details or Item Details screen as needed. 

See our Analytics Glossary for a list of all SearchStax Studio metrics.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Power Search appeared first on SearchStax Docs.

]]>
Search Feedback https://www.searchstax.com/docs/searchstudio/search-feedback/ Mon, 08 Mar 2021 20:30:00 +0000 https://site-qa.searchstax.com/knowledgecenter/?post_type=site_search&p=7709 Search Feedback Studio > Analytics > Search Feedback The Search Feedback page summarizes and tabulates the user feedback messages from your company’s Search Page, as collected by the Feedback Widget. … Continue reading Search Feedback

The post Search Feedback appeared first on SearchStax Docs.

]]>
Search Feedback

Studio > Analytics > Search Feedback


The Search Feedback page summarizes and tabulates the user feedback messages from your company’s Search Page, as collected by the Feedback Widget

The graph on the left is the Net Promoter Score, which is a metric that summarizes the overall positive/negative feedback on a scale from -100 to 100. Positive numbers are good.

The center display shows detractors (feedback 0 to 6), Neutrals (7-8), and Promoters (9 and 10). Of course you can slice the feedback by weekly, monthly, and annual time intervals. 

A little farther down the screen is a table of feedback ratings and messages, along with the email of the feedback source (blurred here for privacy). Note that you can sort the columns for more insight. 

See our Analytics Glossary for a list of all SearchStax Studio metrics.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Search Feedback appeared first on SearchStax Docs.

]]>
Analytics Glossary https://www.searchstax.com/docs/searchstudio/analytics-glossary/ Fri, 23 Apr 2021 15:16:19 +0000 https://www.searchstax.com/docs/?post_type=site_search&p=8683 Analytics Glossary This is a glossary of analytics metrics reported by SearchStax Studio. Description Example Total Searches Total Number of Search Requests in the selected time interval. These include searches… Continue reading Analytics Glossary

The post Analytics Glossary appeared first on SearchStax Docs.

]]>
Analytics Glossary

This is a glossary of analytics metrics reported by SearchStax Studio.

DescriptionExample
Total SearchesTotal Number of Search Requests in the selected time interval. These include searches with results and searches with no results
No Result SearchesTotal Number of Searches that resulted in zero results.
Searches with ResultsTotal Number of Searches that resulted in 1 or more results being shown to the user
ImpressionsResults shown to the user as the result of a search
HitsNumber of items that match this search.
Total Searches with ClicksTotal Number of Searches with at least one click on a result item.
Total ClicksTotal Number of clicks on the Search Results that were shown to the user
Click-Through RateClick-Through Rate is the percentage of tracked searches that generated at least one click on a result.
Mathematically it is (Number of searches with at least 1 click / Total Searches) * 100
Searches with ClicksTotal Number of Searches that resulted in a Click Through Event
Avg Click PositionAverage of the positions of the impressions that were clicked in the list of results
Average Search LatencyAverage Latency across all Searches
Total SessionsTotal number of user sessions when a search was fired. A user can execute multiple searches in a session.
Searches per SessionNumber of Searches per session.
Mathematically, it is Total Searches / Total Sessions
Search ExitsThe number of searches made immediately before leaving the site
% Search ExitsSearch Exits / Total Unique Searches
% No ResultsPercent of Total Searches that produced zero results.
MRRMean Reciprocal Rank. The average of 1/Click Position for all click-through events. It normalizes the score to the range 0 to 1, with 1 being best.
Total ImpressionsTotal Number of Impressions shown across all searches
Total ClicksTotal Number of Clicks that were made on the shown impressions
Item Click-Through RatePercentage of Total Impressions that received a click-through event.
Mathematically, it is  (Total Clicks / Total Impressions) * 100
Searches with Related SearchesNumber of total searches that offered at least one Related Search.
Related Searches with ClicksNumber of Related Searches that were launched by the search user.
Related Searches Click-Through Rate“Related Searches with Clicks” divided by “Searches with Related Searches” x 100.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Analytics Glossary appeared first on SearchStax Docs.

]]>
Results Configuration https://www.searchstax.com/docs/searchstudio/searchstax-studio-search-experience/ Fri, 30 Apr 2021 19:47:13 +0000 https://www.searchstax.com/docs/?post_type=site_search&p=8816 Results Configuration Studio > Search > Results Configuration The Results Configuration screen helps you arrange the information that will appear on your search screen. Questions? Do not hesitate to contact… Continue reading Results Configuration

The post Results Configuration appeared first on SearchStax Docs.

]]>
Results Configuration

Studio > Search > Results Configuration


The Results Configuration screen helps you arrange the information that will appear on your search screen.

  • Results and Display Tab – Choose the fields that will be displayed in the search results, and how the values will be assigned to pre-defined locations in each result card.
  • Facets Tab – Choose the fields that will be consolidated into facet lists, and how the lists will be ordered on the search page.
  • Sorting Tab – Define the options for sorting the search results.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Results Configuration appeared first on SearchStax Docs.

]]>
Results and Display https://www.searchstax.com/docs/searchstudio/results-and-display-tab/ Mon, 08 Mar 2021 21:00:18 +0000 https://site-qa.searchstax.com/knowledgecenter/?post_type=site_search&p=7714 Results and Display Studio > Search Experience > Results Configuration > Results and Display Tab The Results and Display of the SearchStax Studio’s Results Configuration screen lets you configure two… Continue reading Results and Display

The post Results and Display appeared first on SearchStax Docs.

]]>
Results and Display

Studio > Search Experience > Results Configuration > Results and Display Tab


The Results and Display of the SearchStax Studio’s Results Configuration screen lets you configure two important features:

  • It lets you choose which data fields Solr will return in the search results. (To choose which fields will be used to calculate the relevancy score, see the Relevance Modeling > Model Details > Search Fields Tab.)
  • It also lets you assign returned field values to specific display areas on the search-results “card.” (To change the layout of the card itself, see the Theme Editor.)

Select a field from the Return Field droplist to add it to the display of search results. The Label is a human-friendly label to display beside the field value. Click the (X) button on the right to remove it. Note that you can also select a field and use the (+) and (-) buttons to position it in the results list.  

You may also map the field value into a pre-formatted position on the search-results card. For instance, you could assign the document type to the “Ribbon” field to display it in a label at the top of the card. Fields that are mapped to “Url” will be the destination of a results card once clicked. For fields that are set to use “No mapping”, these will be displayed in the results card after all the mapped fields in the order that it is set here.

Mapping a field that contains image URLs to “Thumbnail” will render the images within your results card.

To display the URL as a field value in your results card in addition to making it a destination, use the field once more and set it as a “No mapping”.

Note the Reload Schema icon above the list of fields. If you can’t find a field in the list, try reloading the schema. Changes to your website’s Solr schema are not automatically updated in SearchStax Studio.

Scroll down a little to see the spin button that lets us adjust the number of result items to display in each page of the output. 

Finally, there is a Hit Highlighting checkbox. If checked, matching keywords will be <em>highlighted</em> whenever they appear in a search result. 

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Results and Display appeared first on SearchStax Docs.

]]>