Implementing Nosto
APIs
Leveraging Features
Working with recommendations
The
load method returns a promise which can be consumed to get the raw recommendation data. The raw recommendation data is an object containing the recommendation data.load() vs update()
Recommendation results are returned in a promise by calling either
load() or update(). The difference between these two methods is:load()causes the load count of the most recently tracked page view to be incremented.update()does not automatically increment the page load count.
In order to achieve an accurate reach statistic for recommendations,
load() should be called once per page view when fetching recommendations and all proceeding recommendation requests should use update().Handling attribution
When a recommended product is viewed, the
result_id from the recommendation result should be used. Below is an example recommendation result (some fields have been omitted).1
{
2
"recommendations": {
3
"nosto-frontpage-1": {
4
"result_id": "nosto-frontpage-1-fallback",
5
"products": [{
6
"url": "https://example.com/products/product1",
7
"product_id": "product1"
8
}, {
9
"url": "https://example.com/products/product2",
10
"product_id": "product2"
11
}],
12
"result_type": "REAL",
13
"title": "Most Popular Right Now",
14
"div_id": "nosto-frontpage-1"
15
}
16
}
Copied!
The snippet of code below attributes
product1 to the result id nosto-frontpage-1-fallback from the recommendation result above and fetches recommendations for nosto-productpage-1.1
nostojs(api => {
2
api.defaultSession()
3
.viewProduct('product1')
4
.setRef('product1', 'nosto-frontpage-1-fallback')
5
.setPlacements(['nosto-productpage-1'])
6
.load()
7
.then(data => console.log(data))
8
})
Copied!
Letting Nosto render the HTML
If you wish Nosto to render the recommendations and returns HTML for the recommendations you can set the response mode to HTML by adding
.setResponseMode('HTML') into your call. A full example for 404 page would look like this1
nostojs(api => {
2
api.defaultSession()
3
.setResponseMode('HTML')
4
.viewNotFound()
5
.setPlacements(['notfound-nosto-1', 'bestseller-recs'])
6
.load()
7
.then(data => {
8
// Here you would inject the recommendations to DOM
9
console.log(data.recommendations);
10
})
11
});
Copied!
Please note that Nosto will not inject the returned HTML into the DOM even if the response mode is set to HTML. The logic for injecting the recommendations must be implemented in the application side.
Including Add to Cart-buttons into Recommendations
Usually adding an Add to cart button directly into the recommendation which lists multiple products is fairly straightforward, the website just needs to have an appropriate javascript function to do the operation. Nosto provides ready-made functions for multiple platforms so check the Nosto documentation specific to your e-commerce platform or if needed look into your e-commerce platform's documentation and support on how to create such a function.
Once the Add to cart button is pressed it should call that function to add the products to the cart, but it should also additionally let Nosto know that the button was pressed so Nosto can track the sales from the recommendation. This can be done with the
reportAddToCart function as follows:1
nostojs(api => {
2
api.defaultSession()
3
.reportAddToCart('product-id', 'element')
4
.update()
5
});
Copied!
⚠️ The api call is only for informing Nosto about the attribution (that the product was added from the recommendation),
setCart function in the Session API should be used to tell Nosto the user’s cart contents.Working with content
The
load method returns a promise which can be consumed to get the raw placement data. The raw recommendation data is an object containing the placement data.Working with popups
Popups are handled automatically and you do not need to control the rendering of the popups. As events are dispatched, popups will show and hide automatically. If you would like to have programmatic control over the popups, see our guide on the Popup JS API.
Last modified 4mo ago