WordPress User Guide

1. Getting Started

Steps to follow

1. Create an account on SearchIQ.

2. Copy the API key from SearchIQ account, you can find it after selecting “Add domain” option.

3. Once you’ve created an account, go to your WordPress site and install SearchIQ WordPress plugin.

4. You will be asked to enter your SearchIQ API key.

5. Select the post types you want to search.

6. Index your posts and you are all set!

2. Indexing

2.1 Support Post Types, Custom Fields and Taxonomy

For content you want users to search on your site, we first need to index it. SearchIQ allows you to index different post types along with its corresponding custom fields and taxonomy. With the interface below, you can decide what post types to index, what custom fields you want to filter out, what image in the post you want to use it as thumbnail. SearchIQ only indexes Published posts and we allow you to filter out some posts using post IDs and url patterns.

For any newly added and updated posts, SearchIQ will automatically detect and index them for you as long as the add/update is performed on the WordPress admin console. If you have a big site that you normally add and update your content through database directly, SearchIQ provide 2 solutions for you to synchronize your changes. 1. Delta Sync button – Once click, it will detect the delta and synchronize the changes for you. 2. WordPress URL endpoint – An URL endpoint that you can hit to trigger delta sync once you are done with your database update. This URL endpoint is private to your own instance. If you need this feature enabled, please contact us at [email protected]

2.2 Support PDF (Upcoming!)

SearchIQ can index pdf content with maximum size up to 10MB each. If your pdf is associated to the post as attachment post type, it will be indexed in our end transparently. To improve the index accuracy, it is better if you make your pdf accessible (ie. provide us metadata like title, author, tags in the pdf). To do that, you can follow the video below.

3. Searching

3.1 Autocomplete and Result Page

If you have SearchIQ set up properly, you should be able to see our autocomplete and result page below. If you don’t have search bar or autocomplete is not showing up in your search bar when you type, you can follow the “Setup Your Search Bar” section of this Guide to fix it. For autocomplete, we will show title, description and thumbnail by default. If you are using our cross-domain feature, you will see the domain name as well. For details about cross domain search, you can consult our “Cross Domain Search” Section below. Along with search result, there is thumbnail. For Free account, SearchIQ will generate thumbnails in your server and serve from there. For our paid users, thumbnails are generated and hosted on SearchIQ servers and deliver through CDN for better performance and user experience.

Autocomplete

 

Result Page

 

3.2 Match Option

By default, SearchIQ will return search results based on both relevancy and recency. For a particular user query, our engine will first decide what posts are relevant and rank them based on relevancy score with recency taken into consideration. That is to say, if posts are similar in relevancy, we will rank the latest one higher.

In term of search relevancy, by default, SearchIQ will use Board Match. That is one of the match options that tries to boost up the search coverage by identifying content that has some terms matching the query regardless the word order and form. If you want the match be more restrictive, you can try other matching options like “Full term match” and “Phrase match”.

3.3 Fine-tune the result ranking

a) Field Weight

There are times you want to have better control the result ranking like you want our search engine gives higher priority to the posts the has a title match than description match. To address this need, SearchIQ provides you a field weight control page under “Documents” menu tab that you can go there to adjust the weight at the field level with 10 the highest weight and 0 if you want to ignore.

b) Control what posts to show by user query

If you want to have even more fine-grained control like you want to show a post at the top of the search result for a particular user query, you can achieve this by adding the user query as a tag to your post and give “Tag” field a high weight like 9 to 10 and potentially lower the “Title” weight. This feature may not allow you to explicitly decide what rank #2, #3 and so on but it allows you to show a set of posts for a particular query.

c) Custom sorting (Upcoming!)

SearchIQ will provide custom sorting feature shortly. With this feature, you can do multi-field sorting. For example, if you want the matching content ranked by popularity first and recency next, you can do it in our UI given the popularity field and post date are indexed.

4. Search Analytics

4.1 Analytic Dashboard

SearchIQ tracks what your users searches and clicks on your site and provides you analytic reports. To access your domain reports, login in to SearchIQ admin area, select your domain, and click the Analytics on the left sidebar.

 

In the analytic dashboard, you can see # of searches, # of autocomplete click and # of result page click for your users within a time range you selected. For free account, you can examine the data for the last 24 hours. For larger time range, please consider to upgrade your account. SearchIQ provides both mobile and desktop analytics. You can select view them as a whole under “Traffic: All” or individually. The reports that our users use the most are “Top Search Terms” and “Top Terms with no result” sections. For the “Top Searches Terms” section, you can find out what kinds of content your users expecting from your site. So, you are followed the demand to deliver the content your users interested. For “Top terms with no results” section, you can see if you are really missing out some opportunities there or some search terms are not appeared in your content but you have written about. For latter, you can use our “Synonym” section to fix it. For example, if user search on apparel with brand “A&F” but your product title and description only use the full name “Abercrombie”, it may not come up as a match. If you see “A&F” in your “Top terms with no results” section, you can go to Documents > Synonym Section and add the synonym “Abercrombie, A&F”. This way you are teaching our search engine that they are the same in meaning so next time when user types A&F in search query, Abercrombie products will be shown up in the search result.

4.2 Export the Data

SearchIQ dashboard only shows you top 10 on each analytic section. If you want to obtain a bigger list up to 1000, you can click our “Export” button and download the report data in csv format.

c. Shortcode

Add the following shortcode anywhere on the page, post, custom post type or widget.

[siq_searchbox]

This shortcode can have the following options:

  • type – Accepted values: “search-bar” or “icon”. “search-bar” will show regular text box for search. “icon” will show a clickable search icon for search. Clicking the icon will open a search-bar.
  • post-type: any built-in or custom post type that you have indexed. By default, it includes all post types you index.
  • placeholder: default text that you want to show in the search box
  • width: it can accept any integer value which will be used to set the width of the search box. The integer value may be suffixed by % or px. If the value is added without suffix it will by default take px as the suffix. Default width is 100% of the parent element and for icon it is 300px.
  • placement: “left” or “right”

Example shortcode with options:

[siq_searchbox type="icon" placeholder="Search here" post-types="post,product" width="500" placement="right"]

7. Customization

7.1 Autocomplete Customization

Steps to follow:

1. Go to SearchIQ WordPress plugin.

2. Select Autocomplete tab.

3. Customize the fields as per your requirements.

4. If there is no customization for any specific element you are looking for, please watch this video

7.2 Result Page Customization

Steps to follow:

1. Go to SearchIQ WordPress plugin.

2. Select Results Page tab.

3. Customize the fields as per your requirements.

4. If there is no customization for any specific element you are looking for, please watch this video

7.3 Custom CSS Override

Steps to follow:

1. Go to SearchIQ WordPress plugin.

2. Select Options tab.

3. Add CSS rules to override in Custom CSS text area.

4. Click Save. Its done!