miso.ai Interaction APIs API

Miso’s Interaction APIs let you manage your Interaction records stored with Miso.### Interaction recordsYour 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 contentassets attract the attention of each individual user, and which products or content ultimately will be purchased orconsumed by each of them. With these insights, Miso makes real-time tailored recommendations for each user, andresponds 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 product* `search`: a user made a search request with keywords and (optionally) filtersThe above interactions are the core fuel for Miso's personalization Engines, because they happen in a much higherfrequency 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,you should implement the `product_detail_page_view` interaction to start with.#### Conversion (eCommerce)* `add_to_cart`: a user added a product to the shopping cart* `remove_from_cart`: a user removed a product from the shopping cart* `checkout`: a user checked out and started the payment process* `refund`: a user refunded the product* `subscribe`: a user subscribed to a productThe above interactions are the main revenue drivers for eCommerce sites. It’s important to collect them so thatMiso can not only drive click-through rates, but actually improve the revenue in a targeted way. To start with,you should at least implement the `add_to_cart` interaction.#### Consumption (content media)* `read`, `watch`, and `listen` interactions capture how and for how long a user consumed a piece of content.* `add_to_collection`: a user added an product to their personal collection* `remove_from_collection`: a user removed an product from their personal collectionIf 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 onyour site. If you run a content site, you should implement at least one of these interactions.#### Feedback signals* `like`, `dislike`, `share`, `rate`, and `bookmark` are common ways users express their interests.These are strong signals for Miso to understand each user's preferences regarding your products or content. Youshould send these signals to Miso if you have any of these UI patterns on your site.#### Performance Checking* `impression`: a user saw or was presented with a product or content asset (but didn't yet interact with it)* `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 page* `category_page_view`: a user viewed the page for a specific “group” or “family” or products or content in your catalog* `promo_page_view`: user viewed the promotion pages about certain products* `product_image_view`: user clicked on or otherwise interacted with the product image (e.g. enlarged the image)The above interactions are additional signals for Miso to understand users' behavior on the site.#### Custom* `custom` interaction 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.