Getting Started
This page helps you get started with Avail SaaS
1) Login
Make sure you have the login given to you by Avail. The customer id is in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
2) Upload Data
Upload the filter data to Avail. See section Data for instructions on how to do this.
Inform Avail about the names and data types of the Product Data you are going to upload.
To make the recommendations based on a product, products or a user work well from day one, you can upload an initial feed of transaction data (i.e. order rows).
3) Control Panel
Download the Control Panel which can be found under the tab Resources. This enables you to configure the recommendations, test the recommendations and do some basic administration.
For an in-depth guide on how to use the Control Panel download the Control Panel Guide which can be found under the tab Resources.
4) Feeding Data
Order Data
For the recommendations based on a product, products or a user, Avail SaaS needs order data.
When an order is placed use the method logPurchase to collect new data for recommendations. See tab API for details.
Search Data
For the search recommendations Avail SaaS needs data on searches made. Use saveSearch:
1) When a search has been made and a search result is added to the cart from the search result list
2) When a search is made, user clicks on a search result to go to product detail page and adds that specific product to the cart without any intermediate clicks.
See tab API for more details.
Landing Page Data
For the landing page recommendations Avail SaaS needs data on the search phrase used on the external search engine and the first product added to the cart during the session.
Use saveLandingPageData to collect data for landing page recommendations.
See tab API for details.
Metrics Data
To enable detailed metrics and a set of features like A/B Testing, Avail SaaS needs information on clicked-on and added-to-carts products.
Use logClickedOn and logAddedToCart to collect data.
See tab API for details.
note: logClickedOn and logAddedToCart uses a server generated TrackingCode. You get a TrackingCode returned from the Avail server by committing a predictions request.
5) Making Recommendations
The table below contains the five most common types of recommendations. See Sample Page and API for details on how to implement recommendations.
| Product recommendations |
a.k.a. those who bought this also bought... |
getProductsPredictions |
The product id of the currently viewed product |
| Search Recommendations |
those who searched for 'harry' selected... |
getSearchPredictions |
The search phrase used |
| Cart Recommendations |
Recommendations based on the content of the cart |
getCartPredictions |
The product ids of the products in the cart |
| Click Stream Recommendations |
Recommendations based on the three to five latest clicked on products |
getClickstreamPredictions |
The product ids of the say five latest clicked on products |
| Personal Recommendations |
Personal recommendations based on a single user |
getUserPredictions |
The user id of the logged in or identified user |
| Landing Page Recommendations |
those who searched for 'harry potter' selected... |
getLandingPagePredictions |
The search phrase used on an external search engine such as Google |
Conversion Rate
If it is important to you to get a correct conversion rate in the Avail SaaS metrics, place the script-tag on all landing/entry pages.