Click
Events categorized under the click level are utilized to monitor and analyze user interactions within the storefront. For instance, tracking when a user adds a product to the cart or initiates a login process.
This event is generated to track add to cart actions, indicating when a user has added an item to their shopping cart. It provides comprehensive details about the user, the product added, and the context in which the addition occurred. Context here implies details about the version of the library sending the event and the device information like os, screen size, timezone etc.
Events
click/add_to_cart/engagement/v1
# This event is triggered when a user adds an item to their shopping cart. It includes detailed information about the user, the product added and details about the version of the library and the device information like os, screen size, timezone etc.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the add to cart event.
event_name
string
Required
Name of the event, typically "add_to_cart".
article_id
string
Required
Unique identifier for the article associated with the product.
brand
string
Required
Brand name of the product added to the cart.
cart_id
string
Required
Unique identifier for the shopping cart.
version
string
Required
Version of the event schema.
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
company_id
integer
Required
Unique identifier for the company associated with the event.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
currency
string
Required
Currency code (e.g., "USD", "INR") used for the product price.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
l1_category
string
Required
Primary category of the product (Level 1).
l3_category
string
Required
Tertiary category of the product (Level 3).
position
string|null
Required
Position of the product in the listing when it was clicked on. Use `null` if not applicable.
price
number
Required
Price of the product in the specified currency.
product_id
integer
Required
Unique identifier for the product being added to the cart.
quantity
integer
Required
Number of units of the product added to the cart.
query
string|null
Required
Search query entered by the user, if applicable. Use `null` if not applicable.
search_id
string|null
Required
Identifier for the search journey, if applicable. Use `null` if not applicable.
source_url
string
Required
URL from which the product was added to the cart.
utm_campaign
string
Specific marketing campaign associated with the product addition.
utm_medium
string
Marketing medium through which the user arrived at the product.
utm_source
string
Marketing source driving the traffic to the product.
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string|null
Identifier of the user performing the add to cart action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is generated to track orders checked out by the user, this is emitted after user has checked out the order. It provides essential information about the order and the cart being checked out. In contrast to order checkout which is emitted at checkout page, this event is triggered when user leaves the checkout screen after successfully checking out the order.
Events
click/order_checkedout/conversion/v1
# This event is emitted after the user has checked out the order.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the event.
event_name
string
Required
Name of the event, typically "order_checkedout".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
cart_id
string
Required
Unique identifier for the shopping cart.
cart_total
number
Required
Total amount in the shopping cart before shipping and taxes.
shipping
number
Required
Shipping charges applied to the order.
order_id
string
Required
Unique identifier for the order.
tax
number
Required
Total tax applied to the order.
order_total
number
Required
Total amount of the order after shipping and taxes.
products
array of object
Required
List of products included in the order.
Array of Properties
product_id
integer
Required
Product ID.
l3_category
string
Required
Tertiary category of the product.
l1_category
string
Required
Primary category of the product.
quantity
integer
Required
Quantity of the product purchased.
price
number
Required
Price per unit of the product.
value
number
Required
Total value for the products.
currency
string
Required
Currency code (e.g., "INR").
article_id
string
Required
Article identifier for the product.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.
company_id
integer
Required
Company identifier.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the order checkedout action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is generated to track order checkout events, indicating when a user is checking out an order. It provides essential information about the order and its contents. This event is generated when a user visits the checkout page on the storefront.
Events
click/order_checkout/conversion/v1
# This event is emitted when a user proceeds to checkout an order
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the order checkout event.
event_name
string
Required
Name of the event, typically "order_checkout".
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
cart_id
string
Required
Unique identifier for the shopping cart associated with the order.
cart_total
number
Total amount of the cart before taxes and shipping.
shipping
number
Shipping cost associated with the order.
order_id
string
Unique identifier for the order.
tax
number
Tax amount applied to the order.
order_total
number
Total amount of the order including taxes and shipping.
products
array of object
List of products included in the order.
Array of Properties
product_id
integer
Required
Unique identifier for the product being ordered.
l3_category
string
Required
Tertiary category of the product.
l1_category
string
Required
Primary category of the product.
quantity
integer
Required
Number of units of the product in the order.
price
number
Required
Price per unit of the product.
value
number
Required
Total value for the product (price multiplied by quantity).
currency
string
Required
Currency code (e.g., "USD", "INR") used for the product price.
article_id
string
Required
Unique identifier for the article associated with the product.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.
company_id
string
Required
Unique identifier for the company associated with the event.
version
string
Required
Version of the event schema.
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string|null
Identifier of the user performing the order checkout action. Use `"null"` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
utm_campaign
string
Specific marketing campaign associated with the product checkout.
source_url
string
Required
URL from which the product was added to the cart.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is generated to track order completion events, indicating when a user order has been successfully completed. It provides detailed information about the completed order, including item details, shipment information, and user data.
Events
click/order_complete/conversion/v1
# This event is triggered when a user completes an order on the storefront. It includes detailed information about the order, its contents, and the context in which the order was completed.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the event.
event_name
string
Required
Name of the event, typically "order_complete".
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
order_id
string
Required
Unique identifier for the order.
status
string
Required
Status of the order (e.g., "completed").
breakup_values_raw
object
Required
Detailed breakdown of the order's financials.
Properties
mrp_total
number
Required
Total Maximum Retail Price of all products.
discount
number
Required
Total discount applied to the order.
sub_total
number
Required
Subtotal amount before additional charges.
promotion
number
Required
Total promotion discounts applied.
coupon
number
Required
Total coupon discounts applied.
reward_points
number
Required
Reward points used in the order.
cashback_applied
number
Required
Cashback applied to the order.
cod_charges
number
Required
Cash on Delivery charges, if applicable.
gift_price
number
Required
Total price of gifts included in the order.
delivery_charges
number
Required
Delivery charges for the order.
total
number
Required
Total amount of the order after all adjustments.
shipments
array of object
Required
List of shipments associated with the order.
Array of Properties
shipment_id
string
Required
Unique identifier for the shipment.
status
string
Required
Status of the shipment.
payment_mode
string
Required
Payment mode used for the shipment (e.g., "credit_card", "paypal").
items
array of object
Required
List of items included in the order.
Array of Properties
name
string
Required
Name of the product.
brand
object
Required
Brand details of the product.
Properties
name
string
Required
Name of the brand.
logo
string
Required
URL to the brand's logo.
image
array of string
Required
List of image URLs for the product.
slug_key
string
Required
Slug key for the product URL.
size
string|null
Required
Size of the product. Use `null` if not applicable.
code
string
Required
Unique code for the product.
id
integer
Required
Unique identifier for the product.
category
array of string
Required
List of categories the product belongs to.
l3_category_name
string
Required
Tertiary category name of the product.
l1_categories
array of string
Required
Primary categories of the product.
l2_categories
array of string
Required
Secondary categories of the product.
seller_identifier
string
Required
Identifier for the seller of the product.
attributes
object
Required
Additional attributes of the product.
Properties
brand_name
string
Name of the brand.
media
array|null
List of media URLs related to the product. Use `null` if not applicable.
price
number
Required
Price per unit of the product.
quantity
integer
Required
Quantity of the product ordered.
event_action
string
Required
Specific action related to the event (e.g., "complete_order").
screen
string
Required
Name of the screen where the event occurred.
utm_params
object
Required
UTM parameters associated with the order.
Properties
utm_content
string
Required
Content identifier for the campaign.
utm_medium
string
Required
Marketing medium (e.g., "email", "cpc").
utm_campaign
string
Required
Name of the marketing campaign.
utm_source
string
Required
Source of the marketing traffic (e.g., "newsletter", "google").
screen_view
string
Required
Identifier for the screen view.
user
object
Required
User details.
Properties
_id
string
Required
Unique identifier for the user.
username
string
Required
Username of the user.
emails
array|string
Required
List of user's email addresses.
gender
string
Required
Gender of the user.
active
boolean
Required
Indicates if the user's account is active.
first_name
string
Required
First name of the user.
last_name
string
Required
Last name of the user.
phone_numbers
array|string
Required
List of user's phone numbers.
account_type
string
Required
Type of the user's account.
profile_pic_url
string
Required
URL to the user's profile picture.
user_id
string
Required
Unique identifier for the user in the system.
application_id
string
Required
Identifier for the storefront which user is on.
created_at
string
Required
Timestamp indicating when the user account was created.
updated_at
string
Required
Timestamp indicating when the user account was last updated.
company_id
integer
Required
Unique identifier for the company associated with the event.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
user_id
string|null
Identifier of the user performing the order complete action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is generated to track product listing events, indicating when a user visits the product listing. It provides essential information about the user events.
Events
click/product_listing/conversion/v1
# This event is emitted when a user visits the product listing.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the event.
event_name
string
Required
Name of the event, typically "product_listing".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
query
string|null
Search query used. Use `null` if no search was performed.
search_id
string|null
Required
Unique identifier for the search. Use `null` if no search was performed.
products
array of object
Required
List of products in the event.
Array of Properties
product_id
integer
Required
Product ID.
name
string
Required
Product name.
currency
string
Required
Currency code.
mrp
integer
Required
Maximum retail price.
esp
integer
Required
Effective selling price.
source_url
string
Required
Product source URL.
brand
string
Required
Brand name.
item_total
integer
Required
Total number of items.
company_id
integer
Required
Company identifier.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the product listing action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event generated to track the products searched by the user. It captures actions such as search queries performed along with the query entered by the user. It also provides details like user device and user details to be used for analytical purposes.
Events
click/product_search/search/v1
# This event is triggered when a user interacts with the product search functionality on the storefront.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the event.
event_name
string
Required
Name of the event, typically "product_search".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
query
string
Required
Search query entered by the user.
products
array of string
Required
List of product names returned from the search.
item_total
integer|null
Total number of items found. Use `null` if not applicable.
source
string
Required
Source of the search event.
Enum
company_id
integer
Required
ID of the company.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the product search action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is triggered when the user views a product within the storefront. It captures details such as product ID, category, price, and user information, providing valuable insights for analytical and marketing purposes.
Events
click/product_view/click/v1
# This event is triggered when a user views a product. It includes detailed information about the user, the product viewed, and the surrounding context of the event. Context here implies details about the version of the library sending the event and the device information like os, screen size, timezone etc.
This event is triggered when a user views a product. It includes detailed information about the user, the product viewed, and the surrounding context of the event. Context here implies details about the version of the library sending the event and the device information like os, screen size, timezone etc.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the product view event.
event_name
string
Required
Name of the event, typically "product_view".
version
string
Required
Version of the event schema.
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string|null
Identifier of the user performing the product view action. Use `"null"` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
esp
integer
Required
ESP-related metric associated with the product view action. *(Please provide more context if specific.)*
mrp
integer
Required
Maximum Retail Price of the product being viewed.
brand
string
Required
Brand name of the product viewed.
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
company_id
integer
Required
Unique identifier for the company associated with the event.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
currency
string
Required
Currency code (e.g., "USD", "INR") used for the product price.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
l1_category
string
Required
Primary category of the product (Level 1).
l3_category
string
Required
Tertiary category of the product (Level 3).
query
string|null
Search query entered by the user, if applicable. Use `"null"` if not applicable.
position
string|null
Position of the product on the page. Use `"null"` if not applicable.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
utm_campaign
string
Specific marketing campaign associated with the product view.
product_id
integer
Required
Unique identifier for the product being viewed.
quantity
integer
Required
Number of units of the product viewed. *(Typically 1, but can vary if applicable.)*
search_id
string|null
Identifier for the search session, if applicable. Use `"null"` if not applicable.
source_url
string
Required
URL from which the product was viewed.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is triggered when a user adds a product to their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.
Events
click/product_wishlist_add/engagement/v1
# This event is triggered when a user adds a product to their wishlist on the storefront. It includes detailed information about the user, the product added, and the context in which the addition occurs.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the product wishlist add event.
event_name
string
Required
Name of the event, typically "product_wishlist_add".
version
string
Required
Version of the event schema.
brand
string
Required
Brand name of the product added to the wishlist.
cart_id
string
Required
Unique identifier for the shopping cart associated with the wishlist.
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
company_id
integer
Required
Unique identifier for the company associated with the event.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
currency
string|null
Required
Currency code (e.g., "USD", "INR") used for the product price.
esp
number|null
Required
ESP-related metric associated with the wishlist add action. *(Please provide more context if specific.)*
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
l3_category
string
Required
Tertiary category of the product.
mrp
number|null
Required
Maximum Retail Price of the product being added to the wishlist.
position
string|null
Required
Position of the product in the wishlist or on the page. Use `"null"` if not applicable.
product_id
integer
Required
Unique identifier for the product being added to the wishlist.
quantity
string
Required
Quantity of the product added to the wishlist. *(Typically 1, but can vary if applicable.)*
query
string|null
Required
Search query entered by the user, if applicable. Use `"null"` if not applicable.
search_id
string|null
Required
Identifier for the search session, if applicable. Use `"null"` if not applicable.
source_url
string
Required
URL from which the product was added to the wishlist.
utm_campaign
string
Specific marketing campaign associated with the wishlist addition.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
wishlist_id
string
Required
Unique identifier for the wishlist.
wishlist_name
string
Required
Name of the wishlist.
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string
Identifier of the user performing the wishlist add action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is triggered when a user removes a product from their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.
Events
click/product_wishlist_remove/engagement/v1
# This event is triggered when a user removes a product from their wishlist on the storefront. It includes detailed information about the user, the product removed, and the context in which the removal occurs.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the product wishlist remove event.
event_name
string
Required
Name of the event, typically "product_wishlist_remove".
version
string
Required
Version of the event schema.
wishlist_name
string
Required
Name of the wishlist from which the product was removed.
wishlist_id
string
Required
Unique identifier for the wishlist.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
product_id
integer
Required
Unique identifier for the product being removed from the wishlist.
brand
string
Required
Brand name of the product removed from the wishlist.
l3_category
string
Required
Tertiary category of the product.
mrp
number|null
Required
Maximum Retail Price of the product being removed from the wishlist.
quantity
string
Required
Quantity of the product removed from the wishlist. *(Typically "1", but can vary if applicable.)*
esp
number|null
Required
ESP-related metric associated with the wishlist remove action. *(Please provide more context if specific.)*
currency
string|null
Required
Currency code (e.g., "USD", "INR") used for the product price.
source_url
string
Required
URL from which the product was removed from the wishlist.
utm_campaign
string
Specific marketing campaign associated with the wishlist removal.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string|null
Identifier of the user performing the wishlist remove action. Use `null` if the user is anonymous.
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
company_id
integer
Required
Unique identifier for the company associated with the event.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is triggered when a user removes a product from their shopping cart within the storefront. It captures details such as cart ID, product details, price, and user information, providing insights into user behavior and cart management.
Events
click/remove_from_cart/engagement/v1
# This event is triggered when a user removes a product from their shopping cart within the storefront.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the event.
event_name
string
Required
Name of the event.
brand
string
Required
Brand name of the product.
cart_id
string
Required
Unique identifier for the shopping cart.
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
company_id
integer
Required
Unique identifier for the company.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
currency
string
Required
Currency used for the product price.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
l1_category
string
Required
Category level 1 of the product.
l3_category
string
Required
Category level 3 of the product.
price
number
Required
Price of the product in the specified currency.
product_id
integer
Required
Unique identifier for the product being removed from the cart.
quantity
integer
Required
Quantity of the product removed from the cart.
source_url
string
Required
URL source of the product.
version
string
Required
Version of the event.
user_id
string|null
Identifier of the user performing the remove from cart action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is triggered when a user logs into the storefront. It captures details such as login method, user device, and timestamp, providing insights into user authentication and behavior.
Events
click/user_login/identity/v1
# This event is triggered when a user logs into their account on the storefront. It includes detailed information about the user and the environment from which the login occurs.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the event.
event_name
string
Required
Name of the event (e.g., "user_login").
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
method
string
Required
Method used for login (e.g., "email", "mobile").
Enum
phone
object|string
Phone number used for login.
Properties
phone
string
Required
User's phone number.
active
boolean
Required
Indicates if the phone number is active.
primary
boolean
Required
Indicates if this is the primary phone number.
verified
boolean
Required
Indicates if the phone number is verified.
country_code
integer
Required
Country code of the phone number.
login_value
string
Required
Value used by the user for login. This could be either user's email or phone number.
company_id
integer
Required
ID of the company.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the user login action. Use `null` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?
This event is triggered when a user logs out of the storefront. It provides insights into user session management and behavior.
Events
click/user_logout/identity/v1
# This event is triggered when a user logs out of their account on the storefront. It includes detailed information about the user and the environment from which the logout occurs.
Payload
Properties
context
object
Required
Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.
Properties
library
object
Required
Library information which is sending the event.
Properties
name
string
Required
Name of the library sending the event.
version
string
Required
Version of the library.
os
object
Required
Operating system details for the user device.
Properties
name
string
Required
OS name.
version
string
Required
OS version.
timezone
string
Required
User's timezone.
screen
object
Required
Screen resolution details.
Properties
width
integer
Required
Screen width in pixels.
height
integer
Required
Screen height in pixels.
user_agent
string
Required
User agent information.
locale
string
Required
User's locale information.
device
object
Required
User's device details.
Properties
is_mobile
boolean
Required
Indicates if the device is mobile or not.
event_id
string
Required
Unique identifier for the event.
event_name
string
Required
Name of the event, typically "user_logout".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
company_id
integer
Required
ID of the company.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
company_created_on
string
| date-time
Required
Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string
Required
Identifier of the user performing the user logout action.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
Payload Schema JSON
Payload Example
Was this section helpful?