Implementing Nosto
APIs
Tracking Events
Upon viewing the homepage
When viewing a home-page, there's no context to be provided, so invoking the
viewFrontPage will suffice.1
nostojs(api => {
2
api.defaultSession()
3
.viewFrontPage()
4
.setPlacements(['homepage-nosto-1', 'bestseller-recs'])
5
.load()
6
.then(data => {
7
console.log(data.recommendations);
8
})
9
});
Copied!
Upon viewing a product
When viewing a product, you should send the product-id of the current product being viewed. Unlike the regular implementation, you do not need to pass the entirety of the product metadata.
1
nostojs(api => {
2
api.defaultSession()
3
.viewProduct('product-id')
4
.setPlacements(['product-crosssells'])
5
.load()
6
.then(data => {
7
console.log(data.recommendations);
8
})
9
});
Copied!
Upon viewing a collection
When viewing a category or collection, you should send the slash-delimited and fully-qualified path of the current category.
1
nostojs(api => {
2
api.defaultSession()
3
.viewCategory('/Womens/Dresses')
4
.setPlacements(['category-related'])
5
.load()
6
.then(data => {
7
console.log(data.recommendations);
8
})
9
});
Copied!
Note: You don’t need to ensure the case-sensitivity of the category being passed so long as the path is tagged in the same way as your product’s categories are.
Tagging the categories
Categories must always be delimited by a slash. For example,
/Home/Accessories is a valid category while Home > Accessories is not.Upon doing a search
When viewing the results of a search, you must send the exact search-term as queried for.
1
nostojs(api => {
2
api.defaultSession()
3
.viewSearch('womens dresses')
4
.setPlacements(['search-related'])
5
.load()
6
.then(data => {
7
console.log(data.recommendations);
8
})
9
});
Copied!
Note: You don’t need to normalize or encode the search query in any way.
Upon starting a checkout
When viewing a checkout page, there's no context to be provided, so invoking the
viewCart will suffice.1
nostojs(api => {
2
api.defaultSession()
3
.viewCart()
4
.setPlacements(['cart-related'])
5
.load()
6
.then(data => {
7
console.log(data.recommendations);
8
})
9
});
Copied!
Upon placing an order
On all thank-you and order-confirmation views, the order confirmation metadata must be passed.
The order confirmation metadata is used for sending personalised order-followup emails, personalise the recommendations e.g. order-related, for segmentation insights and conversion statistics.
Important Even if you would not display any recommendations in your order-confirmation view you must still set placements (
.setPlacements(...)) and load (.load()) the results. Setting the order works in a similar manner than cart and customer and an action must be performed for the data to be sent to Nosto.1
nostojs(api => {
2
api.defaultSession()
3
.addOrder(
4
{
5
"external_order_ref": "145000006",
6
"info": {
7
"order_number": "195",
8
"email": "[email protected]",
9
"first_name": "Mridang",
10
"last_name": "Agarwalla",
11
"type": "order",
12
"newsletter": true
13
},
14
"items": [
15
{
16
"product_id": "406",
17
"sku_id": "243",
18
"name": "Linen Blazer (White, S)",
19
"quantity": 1,
20
"unit_price": 455,
21
"price_currency_code": "EUR"
22
}
23
]
24
})
25
.setPlacements(['order-related'])
26
.load()
27
.then(data => {
28
console.log(data.recommendations);
29
})
30
});
Copied!
Upon viewing a page that was not found (404)
When viewing a page / view that was not found, there's no context to be provided, so invoking the
viewNotFound will suffice.1
nostojs(api => {
2
api.defaultSession()
3
.viewNotFound()
4
.setPlacements(['notfound-nosto-1', 'bestseller-recs'])
5
.load()
6
.then(data => {
7
console.log(data.recommendations);
8
})
9
});
Copied!
p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 11.0px Menlo; color: #000000; color: rgba(0, 0, 0, 0.5)}
p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 11.0px Menlo; color: #000000; color: rgba(0, 0, 0, 0.5); min-height: 13.0px}
Upon viewing a general page
When a page with a type - other than the ones listed here - is viewed, there's no context to be provided, so invoking the
viewOther will suffice.1
nostojs(api => {
2
api.defaultSession()
3
.viewOther()
4
.setPlacements(['general-recommendations'])
5
.load()
6
.then(data => {
7
console.log(data.recommendations);
8
})
9
});
Copied!
Last modified 6mo ago