A SearchStax Site Search solution’s Search App is a database that records the history of searches, clicks, searches per session and other analytics over a period of time. It is the foundation of a Site Search project.

This section covers the following topics:

• Creating a Search App
• App Settings

The post Overview appeared first on SearchStax Docs.

Site Search > Profile Selector > Search App menu > +Create

A SearchStax Site Search solution Search App summarizes popular queries and critical metrics such as click-through rate, average click position, mean reciprocal rank, and frequency of no-results searches.

Create a Search App

1. Open the list of Search Apps in the Profile Selector. Click the + Create button.
2. This opens a screen for configuring the new App.
   • App Name: The name must be at least six alphanumeric characters. Underbar (_) is allowed, but other special characters are not.
   • Region: Select a region near your location.
   • Environment: These labels help you differentiate among multiple Apps. They do not limit App behavior in any way.
   • Platform: The options are Sitecore, Drupal, and Custom.
   • Version: The final selection list offers Sitecore and Drupal versions. For a Custom App, no version is offered.
3. Click the Create button to initiate the App. This step needs a few minutes to complete.

Note that a new Search App is simply an empty database. To be useful, it must record user actions from your company website over some significant period of time (days, weeks). There is about a one-hour delay before the first recorded data appears in Site Search.

The post Creating a Search App appeared first on SearchStax Docs.

Site Search > App Settings > All APIs

The SearchStax Site Search solution’s All APIs screen consists of three tabs leading to Site Search API endpoints and credentials.

• Search & Indexing: The Search Endpoint (/emselect), the Ingest Endpoint (/update), and the Auto-Suggest endpoint (/emsuggest), plus the API credentials.
• Discovery: The Related Searches Endpoint, the Popular Searches Endpoint, and the Discovery API Key.
• Analytics: The Analytics Tracking API and the Tracking Key; the Analytics Reporting API and the Reporting Key; and the Search Feedback script.

The post All APIs appeared first on SearchStax Docs.

Site Search > App Settings > All APIs > Search & Indexing

The SearchStax Site Search solution’s Search & Indexing tab displays the Search, Update and Suggest Endpoints.

• Search Endpoint: This endpoint, ending in /emselect, sends Solr queries to the App’s database of searches, content items, feedback, and so forth.
• Update Endpoint: The Update endpoint is used to upload data to the Search App.
• Auto-Suggest Endpoint: This endpoint, ending in /emsuggest, asks for suggestions when a search query returns no results.

Basic and Token Authentication

Search Apps use either Solr Basic Authentication or Token Authentication, depending on account settings. The Search API page covers these topics.

What is the RELOAD SCHEMA button for?

When you add an indexed field to your Sitecore or Drupal site, you must come here and click the Reload Schema button to update the Site Search index. The system will be offline until the update completes.

There is no need to use this button just to update a password.

The post Search & Indexing appeared first on SearchStax Docs.

Site Search > App Settings > All APIs > Discovery

The SearchStax Site Search solution’s Discovery API tab displays the App’s Related Searches Endpoint and the Popular Searches Endpoint. It also displays the APIKeys that enable these features.  These values are used by the Related Searches API and the Popular Searches API.

You can copy the endpoints to the clipboard by clicking the copy icons.

Access to this endpoint is authorized by one or more APIKeys. You may create a key by clicking the Create Key button.

You may mark an individual key active or inactive using the slide switch beside the key. You can delete a key using the (X) delete icon.

• If you inactivate the current key, Related Searches and/or Popular Searches will not appear in the Hosted Search App.
• If you inactivate the current key, have another active key in the table, and generate the Hosted Search App, the next active key from the top of the list will be used.

Questions?

Do not hesitate to contact the SearchStax Support Desk.

The post Discovery appeared first on SearchStax Docs.

Site Search > App Settings > All APIs > Analytics

The SearchStax Site Search solution’s Analytics screen displays the App’s Analytics Tracking endpoint and Analytics Key.  It also presents the Analytics Reporting endpoint and key. Both of these values are used by the Search Events API to send event messages to the correct App.

In addition, the screen includes a script for collecting user feedback.

The post Analytics appeared first on SearchStax Docs.