Interaction APIs
Miso’s Interaction APIs let you manage your Interaction records stored with Miso.
Interaction records
Your Interaction records tell Miso about user interactions with products and content on your site or application. From these interactions, Miso understands how users move through your conversion funnels: which products or content assets attract the attention of each individual user, and which products or content ultimately will be purchased or consumed by each of them. With these insights, Miso makes real-time tailored recommendations for each user, and responds to each of their clicks and views on the site (even for anonymous users).
Interaction records share some common attributes, but are distinguished by their type. Miso captures 23 different interaction types, divided into the following 6 groups:
Core click-streams
product_detail_page_view: a user viewed the detail page for a productsearch: a user made a search request with keywords and (optionally) filters
The above interactions are the core fuel for Miso's personalization Engines, because they happen in a much higher
frequency than other interactions and provide an unbiased and high-fidelity view of users' interests on the site.
The collection of these interactions is highly important for Miso's personalization performance. At the minimum,
implement the product_detail_page_view interaction first.
Conversion (eCommerce)
add_to_cart: a user added a product to the shopping cartremove_from_cart: a user removed a product from the shopping cartcheckout: a user checked out and started the payment processrefund: a user refunded the productsubscribe: a user subscribed to a product
The above interactions are the main revenue drivers for eCommerce sites. It’s important to collect them so that
Miso can not only drive click-through rates, but actually improve the revenue in a targeted way. To start with,
implement at least the add_to_cart interaction.
Consumption (content media)
read,watch, andlisteninteractions capture how and for how long a user consumed a piece of content.add_to_collection: a user added an product to their personal collectionremove_from_collection: a user removed an product from their personal collection
If you are a content site, the above interactions are the main drivers to users' satisfaction on the site. Collecting these interactions allows Miso to drive consumption rates and consumption durations for the content on your site. If you run a content site, implement at least one of these interactions.
Feedback signals
like,dislike,share,rate, andbookmarkare common ways users express their interests.
These are strong signals for Miso to understand each user's preferences regarding your products or content. You must send these signals to Miso if your site has any of these UI patterns.
Performance Checking
impression: a user saw or was presented with a product or content asset (but did not interact with it yet)-
viewable_impression: the product or content presented is actually viewed by the user (for example, minimum of 50% of the pixels were in viewable space for at least one continuous second.) click: a user clicked on something (for example, a product item)
Additional click-streams
home_page_view: user viewed your home pagecategory_page_view: a user viewed the page for a specific “group” or “family” or products or content in your catalogpromo_page_view: user viewed the promotion pages about certain productsproduct_image_view: user clicked on or otherwise interacted with the product image (for example, enlarged the image)
The above interactions are additional signals for Miso to understand users' behavior on the site.
Custom
custominteraction types are reserved for you to define your own business-specific interaction types.
Miso will analyze any custom interactions you define to infer users' interests and preferences.
