Docs

Unbxd Console - Usage Guide

Introduction

All Unbxd product discovery services can be easily controlled and monitored by an advanced user interface called the "console". The console for Unbxd Ecommerce Search was built from ground up with advanced capabilities for merchandising, reporting, user accessibility, and many others. You can create query campaigns, view in-depth reports, grant access to multiple users. The console also offers other useful options like, catalog configurations, synonym libraries, etc. that lets you expose your product inventory in the most optimized way.

Getting Started

This document will teach you how to use the console right from sign up and help make the most out of Unbxd Ecommerce Search on your site or app.

1. Sign up

To access the console you must first create an account.

  • Website URL: Enter the URL of your ecommerce site/app on which you want to integrate Unbxd Ecommerce Search. This will add a site on the console and link your site/app to it. You can however add more sites from the console’s interface.
  • Region: This indicates the physical location of the Unbxd servers (i.e Singapore and US). Choose the option closest to your server to get the best search response. For example, if you are based out of Asia Pacific (APAC) region, choose Singapore, else select US.

Basic Settings

Let’s start from some of the basic and essential settings you need learn before you move on to much advanced ones. The following settings can be accessed at any point on the console, such as:

1. Site Selector

The “Site Selector” is dropdown button that lets you to switch between sites from main menu in order to make setting changes on them. The current site name will be displayed here. You can also add new sites from the “Add New Site” option that appears in the drop-down menu.

2. Account Settings

The standard account settings option is aesthetically positioned on the console and can be easily spotted. Apart from the usual settings, you can change your account password from here.

Dashboard

The dashboard displays an overview of Unbxd Ecommerce Search performance in your site according to various performance metrics for a default period of 2 weeks (or 14 days). The Unbxd performance metrics are explained below:

  • Last Indexing Status: The status (“INDEXED” or “Error”) of the recently uploaded catalog data.
  • Total no of Products: The total number of products in your uploaded catalog data.
  • Last Catalog Upload: The date of the recent upload.
  • Search Queries: The number of search queries made on your ecommerce site since integration.
  • Product Views: The total number of PDP (Product Detail Page) views on your site.
  • Add to Cart events: The total number of products added to cart.
  • Orders: The total number of products ordered.

Commerce Search Revenue Graph

The graph shows the Revenue generated per day for 14 days. It also shows some other useful statistics like:

  • Total Revenue: Total revenue generated on your site.
  • Revenue/Search Visit: Revenue generated per search visit. This metric helps understand the conversion from a product level.
  • Revenue/Search Query: Revenue generated per search query. This metric helps understand the conversion from a query level.

Commerce Search Visit & Query Report Graph

The graph shows the number of Search Hits (Queries and Visits) on daily basis.

Manage

The manage section provides all the essential configuration controls over your account, sites, Unbxd Ecommerce Search tool, and other console settings.

Configure Site

This section provides all the essential controls and options for making an API call and configuring your catalog data.

KEYS

Keys are required for making an API call to Unbxd platforms from a particular site. All API calls to Unbxd are authenticated using these keys:

Site Key

Every Site added on the console has a unique alphanumeric Site Key which is used in all API calls to help us identify your site. A sample Site Key for a site named “testing” looks like this: testing-u1478243900645”.

API Key

Every Unbxd account has a unique hexadecimal API Key which helps us to identify your account. Similar to the Site Key, the API Key is also used in every API call.

Secret Key

Every account also has a unique 32-digit hexadecimal Secret Key. Unlike other keys, the Secret Key is not exposed in the URL, making it safe for important operations such as catalog upload, etc.

API

APIs are the building blocks of Unbxd Ecommerce Search. This section provides API calls on the ready for various operation such as:

  • Commerce Search API
  • Catalog Feed API
  • Typeahead (Autocomplete) API
  • Instant Search API (This is currently unavailable)

You can easily copy these API signatures and start making calls to Unbxd platform. Learn more about these APIs.

CATALOG

You can easily upload or re-upload your catalog data on this section by clicking the Catalog Upload button. If you were not able to upload your catalog data in the beginning, you can do it from this section at any time.

Every upload will be considered as a full-feed upload. A full-feed upload will replace all the previously uploaded data. Learn more about catalog upload.

This section also displays:

  • Catalog Information: Shows the total number of existing products.
  • Last Upload Information: Shows the number of products uploaded in the recent upload and the indexing status.
  • Upload Information: Details of the current upload which includes; Feed File name, Status (Indexed or Error), Date, Time, and Upload Type.

FIELD MAPPING

This section lets you map essential fields from your catalog with Unbxd Dimensions (also known as the Featured Fields) in order for the search engine to leverage semantic relevance. In other words, mapping the Unbxd Dimensions helps us better understand your catalog. There are 26 such fields.

To a map your fields with ours:

  1. Navigate to the ManageConfigure SiteFIELD MAPPING.
  2. Click the Edit icon to enable mapping. Select the right field from the drop down list for its corresponding Unbxd Dimension.
  3. Click Update to save the changes, else click Cancel.

FIELD TYPES

This section lets you view all the fields in your catalog and its field properties. The field properties include:

Field Type

Determines the datatype of a field. A data type determines whether a field is searchable or not. There are 6 different types of datatypes. Learn more about Unbxd datatypes.

For instance, fields like description, meta_description, etc. are configured to “descriptive-text” which is non-searchable.

Multi-Valued

Determines whether a field can have multiple value for a product. For example, usually products come in different colors hence if a product say, “Wrangler plain t-shirt” comes in different colors, then the Multi-Valued property for the “color” field must be set to “Enable” in the schema.

To make changes on these field properties, you need edit your catalog data (also known as Product Feed) and re-upload it from the console. Learn more about catalog upload.

You can sort the field properties by ascending or descending order.

Configuring Search

Search configuration involves:

  1. RELEVANCY RANKING
  2. CONFIGURE FACET

RELEVANCY RANKING

In addition to configuring field types, Relevancy Ranking gives you control over the searchable fields by allowing it to be ranked so that the search results appear based on this arrangement. You can assign the following search weights to rank fields:

  • Non-Searchable
  • Low
  • Normal
  • High

To configure relevancy ranking:

  1. Navigate to the ManageConfigure SearchRELEVANCY RANKING.
  2. Click the Edit icon.
  3. Select the search weight from the drop down list for its corresponding Unbxd Dimension.
  4. Click Update to save the changes, else click Cancel.
TIP: You can also sort the Search Weights by ascending or descending order.

CONFIGURE FACETS

Global facets can be configured from this section.
Learn more about facets
. To create a facet:

  1. Navigate to the ManageConfigure SearchCONFIGURE FACET. A table on the left displays existing facets and a facet configuration panel on the right. If no facets exists, create a new one by clicking the “Add” (+) icon.
  2. On the right panel, type the Name of the facet.
  3. Choose the appropriate option from the Select Attribute dropdown for the facet.
  4. Specify the field Type. In most cases, this will be auto updated based on the field selected.
  5. Specify the Maximum Facet Values. This determines the number of values displayed under a facet field.
  6. Choose the appropriate Sorting Order between count and alphabetical.
  7. Choose the appropriate Sorting Order between count and alphabetical.
  8. Click Create to save the changes, else click Cancel. The new facet will appear in the list of global facets on the left panel. Learn more about facets.

For configuring range facets for fields like “price”, size, etc. specify the Range Start, Range Gap, and Range End.

Libraries

This section only allows you to create Uni-directional or Bi-directional synonyms for keywords.

  1. Navigate to the ManageLibraries.
  2. Click the “Add” (+) icon to begin configuring the keyword.
  3. On the right panel, type in the Synonym Keyword.
  4. Type in the Unidirectional Synonym if any.
  5. Type in the Bidirectional Synonym if any.
  6. Click Create to save the changes, else click Cancel.

The new Synonym Keyword will appear on the table on the left. Synonyms created on the console will overrule Unbxd’s built-in synonym libraries.

User

At this point you (as an Admin) can choose to add Team Members and also manage their accessibility on the console. Adding additional users enable the console to be accessed by multiple users. This option lets you collaborate with your team and make real-time changes on the your site/app.

There are three types of accessibility privileges (which are pretty self-explanatory per se’) you can assign a Team Member with: View/Edit, View only, and No Access. The build and design of the Console makes it convenient to render setting changes in real-time on your site/app.

To Add a Team Member:

  1. Navigate to the ManageUsers.
  2. An Invite User panel on the right shows previously added users.
  3. On the Invite User panel, enter the email address of the user.
  4. Select the user’s Role from the given options i.e. Merchandiser, Analyst or Developer. This lets you manage user’s accessibility privileges for the different sections of the console in the Privilege section.

After you have added users, an Add (+) button will help you next time you want to add users.
Once the user is added, a mail will be sent to the her/his email address which will contain the login credentials.

You can also track history of setting changes made by your team members on the console.


Report

The Report section gives you in-depth insights on the visitor interactions, and query and product performances. Merchandisers can take quick actions on queries, and fields on the site by referring to the Reports section of the console.

The console provides on these features of Unbxd Ecommerce Search:

  1. Search
  2. Typeahead

The Search report includes insights on all visitor events resulted from a query typed in a search field.

Overview

The overview page gives holistic view of essential performance metrics such as Clicks, Carts, Order, Conversion Rate%, Top Searched Queries, Top Clicked, Top Ordered Products, and Zero Results Queries for the last 1 4 days. It helps merchandisers get a complete understanding of the trending queries, products and the zero results query on just quick glance.

You can toggle between 2 types of graphs:

1. Trend Graph

The trend graph lets you view the compare performance of any two metrics for the selected time frame. You can choose to view the trends of - hits, clicks, CTR, carts, orders, conversions and revenue/search and lets you easily switch between , Weekly and Monthly reports.

2. Funnel Report

The funnel graph shows you the conversion funnel of the essential performance metrics data (Hits, Clicks, Carts, Orders) for the selected time frame.

TIP: The Zero Result Query report helps merchandisers view all the queries for which the visitors have seen no result. It is always a best practice to merchandise on the zero result queries first using the various merchandising options the console provides. You can avoid showcasing Zero Results page by, creating synonyms, landing pages, redirects.

The Query Report

Query reports section gives a detailed report of top search queries based on hits, click through rate, clicks, carts, orders, conversion%, and revenue per search. You can search for any query using the search button and download reports in CSV format.

Merchandisers can also drill-down into the performances of each individual query by clicking on it. Doing so can will show you the trends and the funnel report for that particular query. Merchandisers can also view the the details of the popular products for the particular query.

The queries are sorted on hits in ascending order by default, you can however sort on any of the other metrics. A standard date selector interface lets you change the time period for the report. You can also search for a query using the search option.

Typeahead

The typeahead reports section follows the same layout as others. Under the Overview tab, a trend graph shows a comparison between two metrics from cart, order, %conversion rate, revenue, and engagement for 14 days where you can switch between Daily, Monthly and Weekly timeframes. You can also view a 14-day Funnel graph for the query based on hits, clicks, carts, and orders.

Another section shows visitor interactions on Unbxd typeahead doctypes based on their purchase journey. IN-FEATURE, KEYWORD SUGGESTION, TOP QUERIES, POPULAR PRODUCTS
also have their own Trend/Funnel graph with all the options on it.

Merchandising

The Merchandising section of the console provides useful controls that will help you merchandize products in your inventory.

Commerce Search

Merchandising visitor searches is done by creating campaigns based on the business rules you create on the console. There are 3 types of rules you can create:

  • Site
  • Category, and
  • Query

SITE RULE

SITE RULES are defined to be applied site-wide. If there is a conflict between a SITE RULE and a QUERY RULE, and CATEGORY RULE, SITE RULE will take precedence.

In case of conflicts between rules this order of precedence will be followed on the search results: SITE RULE → QUERY RULE → CATEGORY RULE.

To add a SITE RULE:

  1. Navigate to Merchandising → Commerce Search → SITE RULES.
  2. Click the + Add Site Rule button.

This will take you directly to its merchandising page which involves:

  • Boost
  • Filter

Boost

Boosting on a SITE RULE is similar to boosting on a QUERY RULE. Boosting on a SITE RULE lets you promote (or Demote) products on the search results page based on the Attribute Rule for all queries. Boosting can be done on different levels:

  • Demote
  • Low
  • Moderate
  • High

The above boost levels determine the position of the products (from bottom to top respectively) on the search results page.

To create a BOOST GROUP:

  1. Select field name from the dropdown list.
  2. Select comparator based on the field (Equal to, Not equal to, contains, does not contain).
    For price field the comparator options are equal to, in between, more than, less than.
  3. Specify the value.
  4. Assign a boost level. Default is a “Low” boost.

You can create multiple attribute rule for a BOOST GROUP by clicking Add Attribute Rule. You can also create multiple BOOST GROUPS by clicking the ADD ICON.

As a best practice, always assign different boost level across different BOOST GROUP in order to get the desired arrangement of the results.

Filter

Filtering in a SITE RULE allows you to refine the search result for all the queries based on attribute rules.

To create a FILTER GROUP:

  1. Select field name from the dropdown list.
  2. Select comparator based on the field (equal to, not equal to, contains, does not contain).
  3. For price field the comparator options are (equal to, in between, more than, less than). Specify the value.

You can create multiple attribute rule for a FILTER GROUP by clicking Add Attribute Rule. Only the products that satisfy all the attribute rules will be shown in the results. You can also create multiple FILTER GROUPS by clicking the ADD ICON. Only the products that satisfy all the FILTER GROUPS will be shown in the results.

Publish

After you are done creating/configuring your SITE RULES, click on PUBLISH to publish your created site rule.

QUERY RULE

This option allows you to create business rules based on a particular query. This is useful for those queries that are the most searched in your site. This information is easily accessible from the Reporting section of the console.

To create a query rule

  1. Navigate to Merchandising → Commerce Search → QUERY RULES.
  2. Click the + Add Query Rule.
  3. Type the query.
  4. List out the queries similar to the main query. This enables us to show the same merchandising campaign for all the similar queries.
    Similar queries can be edited anytime.
  5. Click Create. The new query rule will be added to list of query rules. Click the query name to enter its campaign management page.
  6. Click the Add (+) button.
Step 1: Campaign Details
  1. Name your campaign. Try to give a straightforward name for easy searching.
  2. Specify the Start Date and End Date. This determines the duration of the campaign on your site.
    End date is optional which means the campaign can run for an indefinite time interval.
  3. Select the your users based on device types: Desktop, Tablet and Mobile.
  4. Describe your campaign. (Optional)
  5. Click NEXT.
Step 2: Merchandise

The Merchandise step has a two-panel interface where one shows a real-time replica of your search result page for the particular query and the other shows different merchandising options. Now, you can either:

  • START MERCHANDISING
  • CREATE A LANDING PAGE
  • Redirect to an existing page.
START MERCHANDISING

As the name suggests, this option lets you start right away with merchandising the search results for the particular search query seen on the left. Merchandising includes:

  • Boost
  • Sort
  • Slot
  • Pin
  • Filter

Boost

Boosting lets you promote (or Demote) products on the search results page based on Attribute Rules. Boosting can be done on different levels:

  • Demote
  • Low
  • Moderate
  • High

The different boost levels determine the position of the products on the search results page. To create a BOOST GROUP:

  1. Select field name from the dropdown list.
  2. Select comparator based on the field (Equal to, Not equal to, contains, does not contain).
    For price field the comparator options are (equal to, in between, more than, less than).
  3. Specify the value.
  4. Assign a boost level. Default is a “Low” boost.
You can create multiple attribute rule for a BOOST GROUP by clicking Add Attribute Rule. You can also create multiple BOOST GROUPS by clicking the ADD ICON.

TIP: As a best practice, always assign different boost level across different BOOST GROUP in order to get the desired arrangement of the results.


Sort

Sorting allows you to rearrange the search results based on certain fields in a particular order. Search results can be sorted in either numerical (ascending/descending) or alphabetical order (A-Z or Z-A) depending on the field value. By default, Unbxd sorts your search results based on relevancy.

To create a SORT GROUP:

  1. Select field name from the dropdown list.
  2. Select Sort Order (Ascending, Descending, A-Z, or Z-A)

You can create multiple attribute rule for a SORT GROUP by clicking Add Attribute Rule. Search results will be sorted according to the order of the sort rules defined. Subsequent rules will be applied to only those products that have the same values for the preceding sort field. For example, you created a SORT GROUP which has the following attribute rules:

  • price (ascending)
  • color (A-Z), and
  • brand (A-Z)

The search result will be in this order:

  • Products with same price and color, sorted on brand (A-Z)
  • Products with same price sorted on color (A-Z)
  • Products sorted on price (ascending)
TIP: You cannot create SORT GROUPS when a Boost/Slot/Pin rules exist.


Slot

Slotting allows you to showcase products from the search results within slots on search results page. Slotting can be used in scenarios where products need to be promoted in only specific positions, preferably at the top of the page.

For instance, if “Tommy Hilfiger” shirts above $100 have a poor inventory turnover rate and there are many such SKUs in the inventory for which the boost feature will only display “Tommy Hilfiger” shirts in the first 2 rows, resulting in a sub-par shopping experience for the visitors due to a lack of variety.

To create a SLOT GROUP:

  1. Choose Range or specify the start and end positions of the slot range.
  2. Select comparator based on the field (Equal to, Not equal to, contains, does not contain).
    For price field the comparator options are (equal to, in between, more than, less than).
  3. Specify the value.

You can create multiple attribute rule for a SLOT GROUP by clicking Add Attribute Rule. Only the products that satisfy all the attribute rules will be shown in the slot. You can also create multiple SLOT GROUPS by clicking the ADD ICON. Each SLOT GROUP allows you to define 10 positions.

TIP: As a best practice, always choose different slot range for different BOOST GROUP in order to get the desired arrangement of the results.


Pin

Pinning lets you arrange your search results by placing individual products on specific positions on the search results page. For example, the sourcing team has finally been able to source “Denim shirts” and you want to promote specific products from the catalog which according to analysis, are selling well in the offline channel.

You cannot pin products on slotted positions.

Apart from the search result page interface, an additional screen containing all the results for the query lets you pin products. There are three ways to pin products:

  1. Enter position on the selected product and click PIN ICON.
  2. Drag and drop the selected product from the left on top of the desired position on the right.
TIP: You can even upload a CSV file of the product-position map and download a CSV file of the existing positions, edit, and re-upload it.


Filter

Similar to filtering in a SITE RULE, filtering on query campaigns allows you refine the search result for a particular query based on attribute rules.

To create a FILTER GROUP:

  1. Select field name from the dropdown list.
  2. Select comparator based on the field. (equal to, not equal to, contains, does not contain).
    For price field the comparator options are (equal to, in between, more than, less than).
  3. Specify the value.

You can create multiple attribute rule for a FILTER GROUP by clicking Add Attribute Rule. Only the products that satisfy all the attribute rules will be shown as results. You can also create multiple FILTER GROUPS by clicking the ADD ICON. Only the products that satisfy all the FILTER GROUPS will be shown as results.

Step 3: Experience

The way the search results page appears greatly impacts visitors’ searching patterns. This makes showcasing the right options at the right places on the results page equally important. Setting the Experience is the last step for publishing your query campaign and involves:

  1. Banner
  2. Layout (This options is currently unavailable.)

There are two ways in which you can create/configure your banner: one is to simply enter the URL of an existing banner image and its corresponding Landing page from the Image url option another is to create an HTML banner in the space provided in the HTML option.

Publish

After you are done creating/configuring your banners, click on PUBLISH to publish your campaign for the created query rule. A page displays essential information about all the created campaigns in a tile view.

Managing your Campaign

For a particular rule, a campaign can exist in one of the following states:

  • Active: The campaigns that are currently running on your site/app. These campaigns are marked green. You can Edit or Duplicate an Active campaign and RE-PUBLISH it.
  • Upcoming: The campaigns that are to be published on a later date. These campaigns are marked blue. You can Edit or Duplicate an Upcoming campaign and RE-PUBLISH it.
  • Expired: The campaign that has crossed its End Date. You can Duplicate an Expired campaign and RE-PUBLISH it.
  • Drafts: The campaigns that are not yet published.
  • Stopped: Those Active campaigns that have been ‘stopped’. A Stopped campaign cannot be restarted again. You can however Duplicate a Stopped campaign and RE-PUBLISH it.
  • You can Delete any campaigns.
  • A Duplicate campaign will have suffix “copy” added to its original campaign name.
  • No two campaigns can be Active for the same device type on the same date range.

CATEGORY RULE

This option allows you to define a category structure that will determine the search results.
For example, you created a category rule,

  • Category: Women,
  • Catlevel 1: Dress,
  • Catlevel 2: Party wear

Now when a visitor searches for “dress”, the search results will show “party wear dresses for women”.The category rules will be applicable for all search query keywords matching with the specified categories irrespective of their searching order. Configuring category rules comes handy for merchandising on long-tailed queries that are the most searched in your site.

The Dashboard and the Reporting section will provide you the information on Top Searched Queries.

To create a category rule:

  1. Navigate to Merchandising → Commerce Search → CATEGORY RULES.
  2. Click the + Add Category Rule button to create a category rule.
  3. Select the Level 1 - Category name from the dropdown.
  4. Select the Level 2 - Category name if any.
  5. Select the Level 3 - Category name if any.
Ensure that you have correctly mapped your category fields with ours in the FIELD MAPPING section.
  • If there are no fields mapped to these Unbxd Dimensions, the category rules cannot be created.
  • If “category structures” are specified in comma-separated format, you would only have to specify the Level 1 - Category name while creating a category rule.

Step 1: Merchandize

(This options is currently unavailable.)

Step 2: Experience

Setting the Experience is the last step for publishing your category rule and it involves:

  • Banner
  • Facets
  • Layout (This options is currently unavailable.)
Banners

Similar to query rules, there are two ways in which you can create/configure your banner for category rules: one is to simply enter the URL of an existing banner image and its corresponding Landing page from the Image url option. Other is to create an HTML banner in the space provided in the HTML option in the banner section.

Configure Facets

Facets on the search results page for the category rule can be configured from this section. Learn more about facets.

A two-paneled page layout offers you facet interaction controls like Show/Hide and Drag/Drop. The right panel helps you create/edit facets.

To create a facet:

  1. Click the “Add” icon.
  2. On the right panel, enter the Facet Name of the facet.
  3. Choose the appropriate option from the Select Attribute dropdown for the facet.
  4. Specify the field Type. In most cases, this will be auto updated based on the field selected.
  5. Specify the Maximum Facet Values. This determines the number of values displayed under a facet field.
  6. Choose the appropriate Sorting Order between count and alphabetical.
  7. Choose the appropriate Sorting Order between count and alphabetical.
  8. Click Create to save the changes, else click Cancel.
For configuring range facets for fields like “price”, size, etc. specify the Range Start, Range Gap, and Range End.

Publish

After you are done creating/configuring your banners, click on PUBLISH to publish your created category rule. A page displays essential information about all the created rules in a detailed list view.

If there is a conflict between a CATEGORY RULE and a QUERY RULE, Query rule will take precedence.

Adding a New Site

A site must be added on the console in order for it replicate the changes you make on it. At first we do this for you from the information provided at sign-up however you can later add more sites on it. For example, at sign-up you gave your “live” (production) site URL, now if you want to add a staging site (for testing purposes) you need to do the following:

  1. On the main menu, click the Site selector dropdown menu that currently displays your live (production) site name.
  2. Click + ADD NEW SITE.
  3. Type your site/app URL in the Add website URL field.
  4. Select a region: US or Singapore
  5. Click Add.

It will take less than 24 hours to validate and add the site to the console. You can switch to other sites anytime from main menu.

Every time you add a Sites you would need to do the Step 1: Integration for that site.