search

Quick Start

hashtag
Overview

These basic steps are required to train and retrieve recommendations.

  • Load the Frontend API

  • Get Recommendations

  • Report events to train and improve recommendations

The frontend API is extremely lightweight, and can be loaded synchronously in the <head> tag. However, If there are any concerns about performance, consider either using "defer", or asynchronous module loading.

hashtag
HTML / UMD

Place the script tag into the <head> section of the DOM. The obviyo API is added to the window object, or added to the UMD module system, if one exists.

<script src="https://cdn.obviyo.net/lib/obv-api.js"></script>

To fetch recommendations, use $fetchRecommendationData. Here is a basic example which fetches the most popular items.

circle-info

By convention, functions prefixed by $ return promises.

const data = await obviyo.$fetchRecommendationData({
    siteId: '{your siteId}',
    qualifiedName: 'psz-mpop'
})

const items = data.items

To directly report user/product interactions, use reportProductInteraction.

hashtag
MODULES / ESM

Modules are widely supported by modern browsers. To use modules, simply use import or import(). No need to include a script tag.

Use dynamic imports to easily try things out in your browser console.

hashtag
Next Steps

  • Learn more about where and how to integrate

  • Api reference

PreviousWelcomeNextIntegration Guide

Last updated