• Browse
    • Search
    • Recs
Menu
  • Browse
    • Search
    • Recs
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages
  • Browse
    • Search
    • Recs
Menu
  • Browse
    • Search
    • Recs
  • Search
    • Browse
    • Recs
Menu
  • Search
    • Browse
    • Recs
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages
  • Get started
  • Documentation
  • Integration Doc
  • FAQ
Menu
  • Get started
  • Documentation
  • Integration Doc
  • FAQ

Down Arrow up_Arrow_active Feed

Direct Feed Upload

  • Prepare your Schema
  • Prepare your Catalog
  • Upload your Feed

Feed API

  • Full Feed Upload
  • Delta Feed Upload
  • Single Record Upload
  • Check Product Count

Down Arrow up_Arrow_active Analytics

Introduction

  •  
  •  

Browser Integration

  • Visitors

GTM Integration

  • Introduction to GTM
  • Requirements

Analytics API

  • Events
  • API Integration

Unbxd Events Validator

  •  
  •  

Down Arrow up_Arrow_active Deploy Unbxd

Search API

  • Search Endpoint
  • Authentication
  • Header
  • Request Parameter
  • Response Components
  • Explanation Request Parameter

PDP API

  • PDP API Format

Autosuggest API

  • Sample Request
  • Request Parameters
  • Response Parameters

Android SDK

  • System Requirements
  • Install SDK
  • Initialize SDK
  • Unbxd Commerce Search
  • Integrating Unbxd Autosuggest
  • Unbxd Analytics
  • Unbxd Browse
  • Unbxd Recommendations
  • Sample App

iOS SDK

  • Installation
  • Unbxd Analytics
  • Unbxd Commerce Search
  • Unbxd Autosuggest
  • Unbxd Browse
  • Unbxd Recommendations
  • Sample iOS App

Javascript Library Integration

  • Quickstart with Unbxd Template
  • Quick Integration to your site
  • Detailed Guide
  • Authentication
  • Types of Pages to Render
  • Configuring the Page
  • Instance Methods
  • More Information
  • Available Configurations

Autosuggest SDK

  • Libraries
  • QuickStart
  • Authentication
  • Configuring Autosuggest
  • Sample Options Object
  • Handlebar Functions
  • List of Configs

Search JS SDK Config

  • Search Template
  • Loader Config
  • Facet Config
  • Pagination
  • Spellcheck
  • Sort Config
  • PageSize Config
  • Breadcrumb Config
  • Product Views
  • Variants

React SDK

  • Quick Integration with Unbxd template
  • Quick Integration to your site
  • Installation
  • Authentication
  • Types of pages to render
  • Configuring the page
  • PageSize Config
  • More Info

Down Arrow up_Arrow_active Onboarding & Platform Integration

Onboarding Flow

  • Create an Unbxd Account
  • Create an Unbxd Site
  • Upload a Catalog
  • Setup Search
  • Integrate Search

Onboarding Flow

  • Create an Unbxd Account
  • Create an Unbxd Site
  • Upload a Catalog
  • Setup Search
  • Integrate Search

Shopify

  • Plugin Installation
  • Configuration
  • Uninstallation
  • Test Plugin Installation

Magento Integration

  • Installation
  • Authentication
  • Catalog
  • Catalog Sync
  • Product Integration
  • Custom Template
  • Indexing Queue View
  • Feed View
  • Upgrade
  • Uninstall

SAP Hybris

  • Installation
  • Authentication
  • Catalog
  • Cron Job
  • Product Config
  • Uninstall

BigCommerce

  • Installation
  • Configuration

Analytics API

Whether you’re a large enterprise or an SME (small-to-medium enterprise) online store owner, your resources are finite. As your business grows, your shoppers are looking for a retail experience that is intuitive and personalized.

Tracking visitor analytics and behaviour anonymously is critical to provide accurate and visitor-specific search and category page results.

To help us analyse and understand your shoppers better, Unbxd captures information for every visitor anonymously by creating the following three sets of cookies:

  • userId: An identifier for the shopper. This cookie never expires.
  • visitId – An identifier for the session/visit. This cookie expires when the shopper is idle for more than 30 minutes.
  • visit – This stores whether the visitor is a ‘first_time’ or ‘repeat’ shopper. This cookie expires when the shopper is idle for more than 30 minutes.

NOTE: Session cookies have an inactivity timer. Sessions expire when they are idle for more than 30 minutes.

The information within these cookies are used to create a non-identifiable persona that allows us to analyze your shopper’s past click-through behaviors, shopping history, and product preferences, in real time. We use this information to provide site-level aggregate reporting.

Unique tracking codes within site interactions help us measure the performance user interactions anonymously. 

Anonymous shopper profiles help fetch personalized search results. It also helps in generating detailed reports.

In other words, information is aggregated and analysed for two purposes:

  • Providing relevant and personalised search & category pages results
  • Generating reports

As a merchandiser or product manager you can make informed decisions and make your shopper’s experience a delightful one.

Events

Events are any action a visitor takes on your eCommerce store. 

Once deployed, the JS code tracks shopper events, using information stored within a cookie titled ‘unbxd.userId’. This file tracks, stores, and relays useful session-based information to Unbxd.

This section helps you understand more about the session-based events we track, like:

  • Visitor: Identifies new and returning shoppers
  • Search Hit: Is the search query performed on the web page
  • Category Page Hit: Category pages are the product listing pages, a visitor visits while browsing on the ecommerce website. For example, pages for categories such as Women -> Dresses, Men ->Shirts, etc on the website. These are also called browse or navigation pages. This event tracks the number of visits for a particular category page.
  • Product Click: Is when a shopper clicks on a product in the PLP.
  • Add to Cart: Is the number of times shoppers have added products to a cart.This event can be fired from both PDP and PLP.
  • Orders: Is the number of orders that have been successfully completed
  • Product Page View: Is the number of times a shopper has visited a specific Product Details Page (PDP)
  • Cart Removal: Is the number of times a shopper has removed a product from the cart
  • Recommendation Widget Impression: Is every time the recommendations widget loads with results
  • Search Impression: Is every time the search results page loads products on the PLP
  • Dwelltime: Is the time a shopper has spent on a product page
  • Facets: Are filters applied for search or browse events

API Integration

In this method, you integrate the API references for every event that you want Unbxd to track.

NOTE: In case you are using a web browser, it is recommended that you use the Browser-based integration.

Here’s a list of all the events that will have our custom APIs integrated.

The calls have to be in the form of an http GET request to the url:

  • Visitor
  • Search Hit
  • Category Page Hit
  • Product Click
  • Add to Cart
  • Order
  • Product Details Page View
  • Recommendation Widget Impression
  • Remove from Cart
  • AutoSuggest
  • Search Impression
  • Category Page Impression
  • DwellTime (time spent on a product page)
  • Facets (filters applied for search or browse event)
tracker.unbxdapi.com/v2/1p.jpg
  • X-Forwarded-For
  • user-agent

Some of the common attributes used in the APIs are described below:

  • data:
    • query: The search query entered in the search box.
    • url: The URL of the page on which the search query was fired.
    • referrer: The url of the previous page, will be empty if the user opened that particular url directly.
    • visit_type: Can be either “first_time” or “repeat”.
  • uid: The unique identifying number for shoppers. Usually we set the “uid” for a particular user in a particular browser. The “uid” is stored within the “uid” cookie, and we store this ID every time we need user-specific event information. We use the following javascript code to populate this:
    var uid='uid-'+date.getTime()+"-"+Math.floor(Math.random()*100000)
  • unbxdKey: The unique ‘iSiteName’ ID generated for you on the Unbxd platform.
    action: Determines the type of event that was fired. Its value differs as per the event.
    t: Random time value for browser cache busting.. This is calculated thus:
    t=(new Date().getTime())+"|"+Math.random() 

Every request needs to be passed with the following HTTP headers:

Visitor

The Visitor event is the first event that gets created when a shopper visits your site. 

There are two types of shoppers we track: 

  • First-time shoppers
  • Repeat shoppers

All shopper events are tracked against an anonymous User ID that is allotted to every shopper visiting your site.  Site-level information, like the “userID”, “siteName”, and “visitType” parameter, are stored in two cookies titled ‘unbxd.userId’ and ‘visitId’. 

 

Both these files are created for the first time when a shopper visits your site for the first time. When a shopper does not have the ‘userID’ cookie or if the shopper has cleared the cookie from their device, that shopper is called as a ‘first-time shopper’. Conversely, when a shopper already has the ‘userID’ cookie, that shopper is a ‘repeat shopper’. 

 

User ID is a random numerical value with the timestamp of the visit and is device/browser-specific.

For instance, a shopper accessing your site on Google Chrome and Mozilla Firefox on the same computer will have two sets of cookies for each browser. 

NOTE: The ‘visitID’ cookie is set to expire after 30 continuous minutes of inactivity. If a shopper returns to your site after the cookie expires, that shopper will be a ‘first-time shopper’.

Here’s how a Visitor API will look like.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"url": "http://www.example.com/","referrer": "", "visit_type": "repeat","ver": "2.8.22.1"}&UnbxdKey=demo-unbxd700181503576558&action=visitor&uid=uid-1409753998404-3525 3&t=1429860079584| 0.48704936588183045 

Where,

  • visit_type: Can be either “first_time” or “repeat”
  • action: Indicates the type of session. In this case, the value will be ‘search’
  • uid: The unique identifying number for shoppers

Search Hit

The Search event is generated every time a shopper uses the search bar to search for a product on your site.

Here’s how a Search API will look like.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"query":"meat","url":"http:// www.example.com/","referrer":"","visit_type":"first_time","ver":"2.8.22.1"} &UnbxdKey=demo-unbxd700181503576558&action=search&uid=uid-1427258791138-3017&t=142725911 7476| 0.5922512758988887 

Where,

  • visit_type: Can be either “first_time” or “repeat”
  • action: Indicates the type of session. In this case, the value will be ‘search’
  • uid: The unique identifying number for shoppers

Category Page Hit

A Category Page event is generated every time a shopper visits a product category page. 

Here’s how a Category Page API will look like.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"page":"home/furniture/entrywayfurniture","page_type":"CATEGORY_PATH","url":"https://www.example.com/shop/entrywa  y-furniture/ho0161","referrer":"https://www.example.com/shop/furniture/ho0115","visit_type":"first_time","ver":"2.8.22"}&UnbxdKey=&action=categoryPage&uid=uid-1427258791138-3017&t=1427259117476| 0.5922512758988887

Where,

  • visit_type: Can be either “first_time” or “repeat”
  • page: category page visited by the user
  • action: Indicates the type of session. In this case, the value will be ‘categoryPage’
  • page_type: classification of the information passed in the “page” key. See the table below for the pages and the corresponding page_types

 

Page 

Page_type

Remarks

ho0161

TAXONOMY_NODE

Taxonomy information is available with Unbxd. Send the taxonomy id in page and “TAXONOMY_NOE” in the page_type

home/furniture/entryway furniture

CATEGORY_PATH

Taxonomy information is not available with Unbxd While sending the category path information set the page_type to “CATEGORY_PATH”

https://www.example.com/shop/

URL

Set page_type to “URL” when tracking hits for a landing page.

NOTE: The information we get by tracking the number of visits via the Category pages must match the information from the copy of your catalog we have.

Product Click

The Product Click event is generated every time a shopper clicks on a product in a Product Listing Page (PLP). 

This helps us understand your shoppers’ search preferences. This information is analyzed to list and promote ‘Popular Products’ and display personalized ‘Recommended For You’ lists.

Here’s how a Product Click API will look like.

 

https://tracker.unbxdapi.com/v2/1p.jpg? data={"pid":"2301609","url":"https://www.example.com/pdp.jsp?productId=veg_pid_2301609&ca tId=veg_local_csa","referrer":"","visit_type":"repeat", "query": , "page": , "requestId": }&UnbxdKey=demo-unbxd700181503576558&action=click&uid=uid-1413889950106-65335&t=1427205349765|0.24967858241871 

Where,

  • <query>: Sends the search query in case of search in the products listing page
  • <page>: Sends the unique identifier for the page passed in the category page API as parameter ‘p’ in case of Category Page.
  • <requestid>: The Unbxd request ID returned in the search/category page/recommendations api call response.
  • action: Indicates the type of session. In this case, the value will be ‘click’

Here’s how a Product Click API will look like.

For recommendations: 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid":"03272224","pr":2,"experience_widget":"WIDGET3","experience_pagetype","HOME","requestId":null,"page":"cat2430045","page_type":"CATEGORY_PATH","UnbxdSiteName":"express_com-u1456154309768","url":"https://www.express.com/mens-clothing/suiting/suit-ensembles/cat2430045?filters=Fit:Fit:Extra%20Slim%26ICID=m-header-suits-extraslim","referrer":"https://www.express.com/mens-clothing/suiting/suit-ensembles/cat2430045","visit_type":"repeat","ver":"4.0.21","_uf":2053858009,"visitId":"visitId-1569495902115-26969"}&UnbxdKey=express_com-u1456154309768&action=click&uid=uid-1559729377841-90561&t=1569495953717|0.31084282827722887

Where,

_uf – browser fingerprint value; generated by the analytics script

  • <query>: Sends the search query in case of search in the products listing page
  • <page>: Sends the unique identifier for the page passed in the category page API as parameter ‘p’ in case of Category Page.
  • <requestid>: The Unbxd request ID returned in the search/category page/recommendations api call response.
  • action: Indicates the type of session. In this case, the value will be ‘click’
  • unbxdParam_sku: UniqueId of the product as defined in the feed
  • unbxdParam_experience_pageType: The PageType of the Page in which the experience widgets will be rendered.
    List of PageTypes available:
  • L3_active Home
  • L3_active Product
  • L3_active Category
  • L3_active Cart
  • L3_active Brand
  • unbxdParam_experience_widget: The widgetType of the rendered experience widget.
    List of widgets available:
  • L3_active Widget 1
  • L3_active Widget 2
  • L3_active Widget 3
  • Example: 
    "607a0bbf-179a-44af-8bdd-e58fef7fc5f3"});
    If you are tracking products clicks on a recommendation widget, you need to call the following API from your Javascript file (in case customer is using Unbxd Recommendations):
    https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid":"03272224","experience_widget":"WIDGET3","experience_pagetype","HOME","requestId":null,"UnbxdSiteName":"express_com-u1456154309768","url":"https://www.express.com/mens-clothing/suiting/suit-ensembles/cat2430045?filters=Fit:Fit:Extra%20Slim%26ICID=m-header-suits-extraslim","referrer":"https://www.express.com/mens-clothing/suiting/suit-ensembles/cat2430045","visit_type":"repeat","ver":"4.0.21","_uf":2053858009,"visitId":"visitId-1569495902115-26969"}&UnbxdKey=express_com-u1456154309768&action=click&uid=uid-1559729377841-90561&t=1569495953717|0.31084282827722887
    Where,
  • pid: The ‘uniqueID’ of the product being clicked. pid should be passed as a string(enclosed in double quotes)
  • experience_widget: The widgetType of the rendered experience widget. List of widgets available:
  • L3_active Widget 1
  • L3_active Widget 2
  • L3_active Widget 3
  • experience_pageType: The PageType of the Page in which the experience widgets will be rendered. List of PageTypes available:
  • L3_active Home
  • L3_active Product
  • L3_active Category
  • L3_active Cart
  • L3_active Brand
  • requestId: The Unbxd requestId returned in the search/category page/recommendations api call response, if available.
  • UnbxdSiteName: The ‘site key’ generated for you on the Unbxd platform
  • URL: The URL of the page on which the product click is triggered
  • referrer: the URL of the previous page
  • visit_type: Can be either “first_time” or “repeat”
  • _uf: browser fingerprint value; generated by the analytics script
  • visitId: The unique identifying number for the visit of the shopper
  • unbxdKey: The ‘site key’ generated for you on the Unbxd platform
  • action: For product click, assign the action to ‘click’. uid: The unique identifying number for shoppers

Add to Cart

The Add to Cart (or known as Cart) event is generated when a shopper adds a product to the shopping cart.

NOTE: When adding a variant to the shopping cart, the event query will have the variant ID as well.

When a product without variants is added to a cart, here’s how the API will look like:

https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid":"07923417","pr":null,"box_type":null,"requestId":null,"page":"cat550007","page_type":"CATEGORY_PATH","UnbxdSiteName":"demo-unbxd700181503576558","url":"https://www.demo-unbxd.com/womens-clothing/dresses/cat550007","referrer":"https://www.demo-unbxd.com/","visit_type":"first_time","ver":"4.0.21","_uf":3277246481,"visitId":"visitId-1572240527765-64643"}&UnbxdKey=demo-unbxd700181503576558&action=click&uid=uid-1572240527753-66798&t=1572240947154|0.04593068792473942a

When a product with variants is added to a cart, here’s how the API will look like:

https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid":"","variantId ":" < variant - id > " ,"qty ":2, "url ":" http://somesitename.com/collections/new-arrivals/products/randys-i-wish-i-were-hiking-bracelet","referrer":"http://somesitename.com/collections/new-arrivals","visit_type":"repeat","ver":"2.11.5"}&UnbxdKey=somesitename_com-u1405972064004&action=cart&uid=uid-1413889950106-65335&t=1417081469168|0.43562852777540684

Where,

  • <query>: Sends search query in case of cart in the Product Listing Page (PLP)
  • <page>: Sends the unique identifier for the page passed in the category page API as parameter ‘p’ in case of Category Page
  • <requestid>(optional): The unbxd request id returned in the search/category page/recommendations api call response, if available. The request id will be available if add to cart option is available for the product at the product listing page/recommendation widget
  • action: Indicates the type of session. In this case, the value will be ‘cart’

Orders

The Orders event is generated every time a shopper places an order successfully on your site.

Here’s how an Order API will look like.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid": "2301609", "price": 100,"qty" : 1, "url":"https://www.example.com/pdp.jsp?productId=veg_pid_2301609&catId=veg_local_csa","referrer":"https://www.example.com/","visit_type":"repeat"}&UnbxdKey=demo-unbxd700181503576558&action=order&uid=uid-1413889950106-65335 &t=1417081469168|0.43562852777540684 

Where,

  • pid: The unique identifying number for products. pid should be passed as a string(enclosed in double quotes)
  • unbxdKey: The unique ‘iSiteName’ ID generated for you on the Unbxd platform
  • visit_type: Can be either “first_time” or “repeat”
  • uid: The unique identifying number for shoppers
  • action: Indicates the type of session. In this case, the value will be ‘order’
  • t: Denotes the period of time the shopper spent on your website
  • price: Price of the product paid by the shopper
  • qty: Quantity of the product bought

Product Details Page View

The Product Details Page (PDP) view indicates the total number of times a product has been visited by shoppers irrespective of the source; search result page, category page, search engine, email, marketing campaigns and so on. 

Here’s how a PDP API will look like:

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid":"6669662","referrer":"https://www.example.com/shop/entryway-furniture/ho0161","url":"https://www.example.com/products/safavieh-hampton-pillowtop-bench-in-blue/6669662":"first_time","ver":"2.8.22"}&UnbxdKey=&action=product_view&uid=uid-1427258791138-3017&t=1427259117476| 0.5922512758988887 

Where,

  • pid: The unique identifying number for shoppers. pid should be passed as a string(enclosed in double quotes)
  • unbxdKey: The unique ‘iSiteName’ ID generated for you on the Unbxd platform
  • visit_type: Can be either “first_time” or “repeat”
  • uid: The unique identifying number for shoppers
  • action: Indicates the type of session. In this case, the value will be ‘order’
  • t: Denotes the period of time the shopper spent on your website
  • price: Price of the product paid by the shopper
  • qty: Quantity of the product bought

Recs Widget Impression

The Recommendations Experience Widget event is generated every time a shopper clicks on a product in the recommendations widget within the PDP.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"experience_widget":"WIDGET1","experience_pagetype":"PRODUCT", "path":"/product","identifier":"1692663-285","pids_list":["1692741-1758","01692015-285","1692908-480","01702359-75","00282168-1758","01792315-1758","1692429-704","01762348-393","01762131-75","01692287-806"],"url":"https://fashion.unbxdapi.com/product?pid=1692663-285","referrer":"https://fashion.unbxdapi.com/","visit_type":"repeat","domain":".unbxdapi.com","_uf":1112242517,"visitId":"visitId-1508916052443-42701"}&UnbxdKey=fashion-unbxdapi-com63470-1490017171&action=EXPERIENCE_IMPRESSION&uid=uid-1505367433938-23646&t=1508916089173|0.454981110944898  

NOTE: This event is generated only when you have subscribed to our Recommendations solutions.

  • unbxdParam_sku: UniqueId of the product as defined in the feed
  • unbxdParam_experience_pageType: The PageType of the Page in which the experience widgets will be rendered. List of PageTypes available:
  • L3_active Home
  • L3_active Product
  • L3_active Category
  • L3_active Cart
  • L3_active Brand
  • unbxdParam_experience_widget: The widgetType of the rendered experience widget.
    List of widgets available: 
    WIDGET 1
    WIDGET 2
    WIDGET 3
  • pids_list: The unique identifier of all the products listed in the PLP as defined in the feed schema.
  • visit_type: Can be either “first_time” or “repeat”
  • action: Indicates the type of session. In this case, the value will be ‘impression’
  • uid: The unique identifying number for shoppers

Remove from Cart

The Remove From Cart event tracks every instance a product is removed from cart as well. Information it helps us better understand the visitor’s preferences. 

When a product with variants is removed from the cart, here’s how the API will look like.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid":"6669662","variantId":"abcdefg","qty":2,"referrer":"https://www.example.com/shop/entryway-furniture/ho0161","url":"https://www.example.com/checkout/bag":"first_time","ver":"2.8.22"}&UnbxdKey=&action=cartRemoval&uid=uid-1427258791138-3017&t=1427259117476|0.5922512758988887   

Where,

  • pid: The unique identifying number for shoppers. pid should be passed as a string(enclosed in double quotes)
  • unbxdKey: The unique ‘iSiteName’ ID generated for you on the Unbxd platform
  • action: Indicates the type of session. In this case, the value will be ‘product_view’
  • uid: The unique identifying number for shoppers

Autosuggest

An autosuggest event is fired when a user types something, then clicks on any of autosuggest results shown.

Here’s how an Autosuggest API looks like.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"query":"Red Socks","autosuggest_data":{"autosuggest_type":"IN_FIELD","autosuggest_suggesti on":"Red Socks","field_value":"Dress Sock","field_name":"infield1","src_field":"color type","pid":null,"unbxdprank":6,"internal_query":"red"},"UnbxdSiteName":"","url":"http://www.example.com/search?q=Pink+Shirt","referrer":"http://www. example.com","visit_type":"repeat","ver":"2.13"}&UnbxdKey=&action=search h&uid=uid-1473341584324-43521&t=1493663167779|0.5231064587647083   

Where,

  • query: Indicates products included in the autosuggest widget
  • autosuggest_type: It can be IN_FIELD, POPULAR_PRODUCTS, TOP_SEARCH_QUERIES, KEYWORD_SUGGESTION, PROMOTED_SUGGESTIONS
  • internal_query: Indicates the query for which autosuggest results were generated
  • field_value: Set when autosuggest_type is IN_FIELD. Set to the value of the “in field” in unbxd response.It is set null otherwise
  • field_name: Set when autosuggest_type is IN_FIELD. Name of the autosuggest field in the search response.It is set to null otherwise
  • src_field: Name of the fields present in the catalogue on the combination of which in fields are generated.It is set when autosuggest_type is not null
  • pid: The unique identifying number of the product. It is set non null when autosuggest_type is POPULAR_PRODUCTS
  • action: Indicates the type of session. In this case, the value will be ‘search’

Search Impression

A Search Impression (also known as Product Impressions) event is generated after a shopper gets a list of products on the search results page. This event is also generated every time a shopper refines the results by facets, filters, scroll-down or pagination. The productId of the products listed in the PLP will be sent as a payload.

Here’s how a Search Impression API will look like.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"query":"shirt","pids_list":["1692457-319","01692287-806","01692289-75","01692286-75","01692282-172","01702279-75","01702279-393","01702279-1517","01702279-764","9792225-1310","09702112-1455","01702280-998"],"url":"https://fashion.unbxdapi.com/search?q=shirt","referrer":"https://fashion.unbxdapi.com/","visit_type":"repeat","domain":".unbxdapi.com","_uf":1112242517,"visitId":"visitId-1508912632835-36088"}&UnbxdKey=fashion-unbxdapi-com63470-1490017171&action=search_impression&uid=uid-1505367433938-23646&t=1508912975558|0.34440504766324276  

Where,

  • query: Sends the search query in case of search in the Products Listing Page (PLP)
  • pids_list: The unique identifier of all the products listed in the PLP as defined in the feed schema
  • visit_type: Can be either “first_time” or “repeat”
  • action: Indicates the type of session. In this case, the value will be ‘search_impression’
  • uid: The unique identifying number for shoppers

Category Page Impression

A Category Page Impression event is fired when a category page loads for the first time, and whenever the results change on applying pagination, auto-scroll, sort, and filters. For each of these actions, unique Ids of the products visible on the search page should be sent as payload.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"page":"/men/shirt", “page_type”: “URL”, "pids_list":["1692457-319","01692287-806","01692289-75","01692286-75","01692282-172","01702279-75","01702279-393","01702279-1517","01702279-764","9792225-1310","09702112-1455","01702280-998"],"url":"https://fashion.unbxdapi.com/men/shirts","referrer":"https://fashion.unbxdapi.com/","visit_type":"repeat","domain":".unbxdapi.com","_uf":1112242517,"visitId":"visitId-1508912632835-36088"}&UnbxdKey=fashion-unbxdapi-com63470-1490017171&action=browse_impression&uid=uid-1505367433938-23646&t=1508912975558|0.34440504766324276  

In this case, the value of the “action” parameter would be browse_impression. “pids_list” would be a list of PIDs of products visible in the window when the event occurs.

Where,

  • query: Sends the search query in case of search in the Products Listing Page (PLP)
  • pids_list: The unique identifier of all the products listed in the PLP as defined in the feed schema
  • visit_type: Can be either “first_time” or “repeat”
  • action: Indicates the type of session. In this case, the value will be ‘browse_impression’
  • uid: The unique identifying number for shoppers

DwellTime

A Dwelltime event is generated to indicate the time spent on the Product Details Page (PDP). This event is generated every 10 seconds and serves to indicate the amount of time a shopper remains on the page. 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"pid":"1692663-285","dwellTime":877005,"url":"https://fashion.unbxdapi.com/product?pid=1692663-285","referrer":"https://fashion.unbxdapi.com/","visit_type":"repeat","domain":".unbxdapi.com","_uf":1112242517,"visitId":"visitId-1508916052443-42701"}&UnbxdKey=fashion-unbxdapi-com63470-1490017171&action=dwellTime&uid=uid-1505367433938-23646&t=1508917013109|0.7136163149806576  

Where,

  • pid: The unique identifying number of the product
  • visit_type: Can be either “first_time” or “repeat”
  • action: Indicates the type of session. In this case, the value will be ‘dwellTime’
  • uid: The unique identifying number for shoppers

Facets

A Facet event is generated to indicate the filters a shopper has chosen after getting the search results page. The event query will list the specific filters the shopper has selected to narrow down the results on the search results page.

 

https://tracker.unbxdapi.com/v2/1p.jpg?data={"query":"shirt","facets":{"fit_fq":["Fitted"]},"url":"https://fashion.unbxdapi.com/search?q=shirt","referrer":"https://fashion.unbxdapi.com/","visit_type":"repeat","domain":".unbxdapi.com","_uf":1112242517,"visitId":"visitId-1508916052443-42701"}&UnbxdKey=fashion-unbxdapi-com63470-1490017171&action=facets&uid=uid-1505367433938-23646&t=1508917308101|0.3318202718675367  

Where,

  • query: Sends the search query in case of search in the Products Listing Page (PLP)
  • facets: Indicates all the selected facets
  • visit_type: Can be either “first_time” or “repeat”
  • action: Indicates the type of session. In this case, the value will be ‘dwellTime’
  • uid: The unique identifying number for shoppers
  • Did this answer your question?
  • Yes!

    Nice work, I love it.

    Feedback is submitted

On this Section

  • To create a Query Rule
  • To Edit a Query Rule
  • Delete a Query Rule
  • Campaign States
  • Create Campaigns
  • Edit Campaigns
  • Preview Campaigns
  • Duplicate Campaigns
  • Delete Campaigns

Copyright 2020 © Unbxd Inc, All Rights Reserved. Privacy Policy