# Clickstream
{% hint style="info" %}
Clickstream extension is automatically installed from the shopify app
{% endhint %}
Our custom-built user event tracking solution empowers store owners to comprehensively monitor and analyze user engagements on their websites. Our APIs take the signals from the clickstream data to provide more relevant product recommendations.
\
Add this code to Global HTML or every page on your website. Replace the Client\_id and API\_KEY with actual values from your store.
```html
Your Page Title
```
## Events
Please add code to track the following events with the payload specified in the documentation.
### page\_viewed
```javascript
let event_name = "page_viewed"
let EventData = {
user_id: user_id,
data: event.data,
};
discoveristTracker.sendEvent(event_name,EventData);
```
### product\_viewed
```javascript
let event_name = "product_viewed"
let EventData = {
user_id: user_id,
products: [{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
### search\_submitted
```javascript
let event_name = "search_submitted"
let EventData = {
user_id: user_id,
search_string: search_string,
};
discoveristTracker.sendEvent(event_name,EventData);
```
### product\_added\_to\_cart
```javascript
let event_name = "product_added_to_cart"
let EventData = {
user_id: user_id,
products: [{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
### checkout\_started
```javascript
let event_name = "checkout_started"
let EventData = {
user_id: user_id,
products: [{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
product_quantity: event.data.productVariant.price.quantity
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
### checkout\_completed
```javascript
let event_name = "checkout_completed"
let EventData = {
user_id: user_id,
products: [{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
product_quantity: event.data.productVariant.price.quantity,
discount_codes: discount_codes
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
### module\_loaded\_discoverist
{% tabs %}
{% tab title="bundle" %}
```javascript
let event_name = "module_loaded_discoverist"
let EventData = {
user_id: event.clientId,
event_source: bundle, //bundle, similar, recently_viewed
bundles: [
bundle_name: bundle_name,
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="similar" %}
```javascript
let event_name = "module_loaded_discoverist"
let EventData = {
user_id: event.clientId,
event_source: similar, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="recentlyviewed" %}
```javascript
let event_name = "module_loaded_discoverist"
let EventData = {
user_id: event.clientId,
event_source: recently_viewed, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% endtabs %}
### module\_viewed\_discoverist
{% tabs %}
{% tab title="bundle" %}
```javascript
let event_name = "module_viewed_discoverist"
let EventData = {
user_id: event.clientId,
event_source: bundle, //bundle, similar, recently_viewed
bundles: [
bundle_name: bundle_name,
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="similar" %}
```javascript
let event_name = "module_viewed_discoverist"
let EventData = {
user_id: event.clientId,
event_source: similar, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="recentlyviewed" %}
```javascript
let event_name = "module_loaded_discoverist"
let EventData = {
user_id: event.clientId,
event_source: recently_viewed, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% endtabs %}
### product\_clicked\_discoverist
{% tabs %}
{% tab title="bundle" %}
```javascript
let event_name = "product_clicked_discoverist"
let EventData = {
user_id: event.clientId,
event_source: bundle, //bundle, similar, recently_viewed
bundle_name: bundle_name,
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="similar" %}
```javascript
let event_name = "product_clicked_discoverist"
let EventData = {
user_id: event.clientId,
event_source: similar, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="recentlyviewed" %}
```javascript
let event_name = "product_clicked_discoverist"
let EventData = {
user_id: event.clientId,
event_source: recently_viewed, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% endtabs %}
### product\_added\_to\_cart\_discoverist
{% tabs %}
{% tab title="bundle" %}
```javascript
let event_name = "product_added_to_cart_discoverist"
let EventData = {
user_id: event.clientId,
event_source: bundle, //bundle, similar, recently_viewed
bundle_name: bundle_name,
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="similar" %}
```javascript
let event_name = "product_added_to_cart_discoverist"
let EventData = {
user_id: event.clientId,
event_source: similar, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% tab title="recentlyviewed" %}
```javascript
let event_name = "product_added_to_cart_discoverist"
let EventData = {
user_id: event.clientId,
event_source: recently_viewed, //bundle, similar, recently_viewed
products:[{
product_id: event.data.productVariant.product.id,
product_name: event.data.productVariant.product.title,
currency: event.data.productVariant.price.currencyCode,
product_price: event.data.productVariant.price.amount,
}]
};
discoveristTracker.sendEvent(event_name,EventData);
```
{% endtab %}
{% endtabs %}