Event-specific attributes

Check out our Events overview page to understand the functioning of each event.

Visitor

Template API:

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"url":"{{url-of-the-website}}",
"referrer":"{{reference-link}}",
"visit_type":"{{first-or-repeat}}",
"visitId":"{{visitId}}"}
&UnbxdKey={{unbxd_sitekey}}
&action=”visitor”
&uid=”uid-1642414737751-2003”
&t=”1662364656435|0.29442892143527755”

Refer here for our sample API

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`visitor`
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `first_time` or `repeat`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Search Hit

Template API:

https://tracker.unbxdapi.com/v2/1p.jpg
?data=%7B%22url%22%3A%22https%3A//www.demo.unbxd.com.au/c/Sofas%3F
redirectq%3Dsofas%22%2C%22
referrer%22%3A%22https%3A//www.demo.unbxd.com.au/search/Sofas%22%2C%22
visit_type%22%3A%22repeat%22%2C%22ver%22%3A%224.0.28%22%2C%22_
uf%22%3A3902881952%2C%22
visitId%22%3A%22visitId-1709116400821-5910%22%7D
&UnbxdKey=demo-unbxd700181503576558
&action=visitor
&uid=uid-1707194142543-92694
&t=1709118200869%7C0.3265333503179766

Refer here for our sample API

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`search`
`query`	`string`	The search query entered by the shopper
`url`	`string`	Website URL where the search is performed
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Search Impression

Template API:

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"query":"{{search-query}}",
"pids_list":"{{list-of-products-uniqueId}}",
"url":"{{url-of-the-website}}",
"referrer":"{{referrer}}",
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=PRODUCT_IMPRESSIONS
&uid={{uid}}
&t=1662366285967|0.7498946341398707

Refer here for our sample API

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`PRODUCT_IMPRESSIONS`
`pid`	`string`	Unique ID for the product, to be taken from the search API response
`variantId` (optional)	`string`	Variant ID assigned to the variant of the product. Necessary only if variants are present.
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `first_time` or `repeat`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Browse Impression

Template API:

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"page":"categoryPathId:\"117>119\"",
"page_type":'{{category-page-type}}',
"pids_list":"{{list-of-products-uniqueId}}",
"url":"{{url-of-the-website}}",
"referrer":"{{referrer}}",
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=PRODUCT_IMPRESSIONS
&uid={{uid}}
&t=1662366068017|0.9865798147898728

Refer here for our sample API

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`PRODUCT_IMPRESSIONS`
`pid`	`string`	Unique ID for the product, to be taken from the search API response
`qty`	`string`	The number of units added to the cart (as a string). For example, `“2”` for 2 units.
`variantId` (optional)	`string`	Variant ID assigned to the variant of the product. Necessary only if variants are present.
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `first_time` or `repeat`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Product Click

Template API:

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"pid":"{{uniqueId-of-the-product}}",
"url":"{{url-of-the-website}}",
"referrer":”{{reference-link}}”,
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=click&uid={uid}}
&t=1662365583875|0.7442797542869459

Refer here for our sample API

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`click`
`pid`	`string`	Unique ID for the product, to be taken from the search API response
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `first_time` or `repeat`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Template API: Selection and Deselection of facets

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"query":"{{search-query}}",
"facets":{"facet-name1":{ "prank": "1","selected":
[{"prank": "2", "val": "facet_value1"},
  {"prank": "3","val": "facet_value2"}]}, 
  "facet-name2":{ "prank": "2","deselected":
  [{"prank": "4", "val": "facet_value1"},
  {"prank": "7","val": "facet_value2"}]}},
  "url":"{{url-of-the-website}}",
  "referrer":"{{referrer}}",
  "requestId":"{{unx-request-id}}",
  "visit_type":"{{first_or_repeat}}",
  "visitId":"{{visit-id}}"}
  &UnbxdKey={{unbxd-sitekey}}
  &action=facets&uid={{uid}}5
  &t=1662365253141|0.6835012308821242

Template API: Clear All facets

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"query":"{{search-query}}",
"facets":{"unxFacetsReset":true},
"url":"{{url-of-the-website}}",
"referrer":"{{referrer}}",
"requestId":"{{unx-request-id}}",
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=facets&uid={{uid}}5
&t=1662365253141|0.6835012308821242

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`facets`
`pid`	`string`	Unique ID for the product, to be taken from the search API response
`qty`	`string`	The number of units added to the cart (as a string). For example, `“2”` for 2 units.
`variantId` (optional)	`string`	Variant ID assigned to the variant of the product. Necessary only if variants are present.
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `first_time` or `repeat`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Template API: Selection and Deselection of facets

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"page":"categoryPathId:\"117>119\"",
"page_type":"{{category-page-type}}",
"facets":{"facet-name1":{ "prank": "1","selected":[{"prank": "2", "val": "facet_value1"},
{"prank": "3","val": "facet_value2"}]}, 
"facet-name2":{ "prank": "2","deselected":
[{"prank": "4", "val": "facet_value1"},{"prank": "7","val": "facet_value2"}]} },
"url":"{{url-of-the-website}}",
"referrer":"{{referrer}}",
"requestId":"{{unx-request-id}}",
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=facets&uid={{uid}}5
&t=1662365253141|0.6835012308821242

Template API: Clear All facets

http://tracker.unbxdapi.com/v2/1p.jpg
?data={"page":"categoryPathId:\"117>119\"","page_type":"{{category-page-type}}",
"facets":{"unxFacetsReset": true },
"url":"{{url-of-the-website}}",
"referrer":"",
"requestId":"{{unx-request-id}}",
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=facets&uid={{uid}}5
&t=1662365253141|0.6835012308821242

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`facets`
`pid`	`string`	Unique ID for the product, to be taken from the search API response
`qty`	`string`	The number of units added to the cart (as a string). For example, `“2”` for 2 units.
`variantId` (optional)	`string`	Variant ID assigned to the variant of the product. Necessary only if variants are present.
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `first_time` or `repeat`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Add to Cart

Template API:

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"pid":"{{uniqueid-of-the-product}}",
"qty":”{{no-of-units}}",
"variantId":"{{variantId-of-the-variant}}",
"url":"{{url-of-the-website}}",
"referrer":”{{reference-link}}”,
"visit_type":"{{first-or-repeat}}"
&UnbxdKey=”{{unbxd-sitekey}}"
&action=cart&uid={{uid}}&t={{time-spent}}

Refer here for our sample API

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`cart`
`pid`	`string`	Unique ID for the product, to be taken from the search API response
`qty`	`string`	The number of units added to the cart (as a string). For example, `"2"` for 2 units.
`variantId` (optional)	`string`	Variant ID assigned to the variant of the product. Necessary only if variants are present.
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `"first_time"` or `"repeat"`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Order

Template API for single product:

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"pid":"{{uniqueId-of-the-product}}",
"qty":"{{quantity-selected}}",
"price":"{{unit-price-for-product}}",
"url":"{{url-of-the-website}}",
"referrer":”{{reference-link}}”,
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=order
&uid={{uid}}1658904085468-92302
&t=1662367087116|0.07798836811209986

Template API for multiple product:

https://tracker.unbxdapi.com/v2/1p.jpg
?data={"products":[{"pid":"{{uniqueId-of-the-product}}",
"qty":"{{quantity-selected}}",
"price":"{{unit-price-for-product}}"}, {"pid":"{{uniqueId-of-the-product}}",
"qty":"{{quantity-selected}}",
"price":"{{unit-price-for-product}}"}],
"url":"{{url-of-the-website}}",
"referrer":"{{reference-link}}",
"visit_type":"{{first_or_repeat}}",
"visitId":"{{visit-id}}"}
&UnbxdKey={{unbxd-sitekey}}
&action=order
&uid={{uid}}1658904085468-92302
&t=1662367087116|0.07798836811209986

Refer here for our sample API

Payload details:

Attribute Name	Type	Value to Pass
`action`	`string`	`order`
`pid`	`string`	Unique ID for the product, to be taken from the search API response
`qty`	`string`	The number of units added to the cart (as a string). For example, `"2"` for 2 units.
`variantId` (optional)	`string`	Variant ID assigned to the variant of the product. Necessary only if variants are present.
`price`	`string`	Unit price of the product and its variant (if variant is selected).
`url`	`string`	Website URL where the search is performed
`visit_type`	`string`	Either `"first_time"` or `"repeat"`
`UnbxdKey`	`string`	UnbxdSitekey value
`uid`	`string`	`unbxd.userId` (Needs to be extracted from the cookie)
`t`	`string`	Timestamp formula: `t : current_time \| random number between 0 to 1` and `t = new Date().getTime() + ‘\|’ + Math.random();`
`referrer`	`string`	Link from where the page is opened `referrer: sessionStorage.getItem('urlPrevious') \|\| document.referrer \|\| '';`

Getting Started

Onboarding

Multi Store API

V2 Analytics Integration

Event-specific attributes

Visitor

Search Hit

Search Impression

Browse Impression

Product Click

Search Facets

Browse Facets

Add to Cart

Order

Getting Started

Onboarding

Multi Store API

V2 Analytics Integration

​Visitor

​Search Hit

​Search Impression

​Browse Impression

​Product Click

​Search Facets

​Browse Facets

​Add to Cart

​Order

Visitor

Search Hit

Search Impression

Browse Impression

Product Click

Search Facets

Browse Facets

Add to Cart

Order