Create an API-based Smart Recommender Campaign
  • 08 May 2024
  • 2 Minutes to read

    Create an API-based Smart Recommender Campaign


      Article Summary

      API-based Smart Recommender allows you to design your own smart recommender widgets on your end and integrate them to Insider's Smart Recommender API. With this campaign type, you can keep creating and editing all other campaign configurations (e.g. segments, A/B testing, analytics, etc.) on Insider's InOne panel.

      Your title goes here
      API-based campaign type is supported by Desktop Web Smart Recommender and Mobile Web Smart Recommender.

      Completing two steps in a row, you can launch an API-based campaign;
      1. Create your widget on InOne
      2. Integrate your widget to Insider's Smart Recommender API

      1. Create your widget on InOne

      1. Navigate to Experience > Discover > Web Smart Recommender.

      2. Click the Create button.

      3. Select the Import via API method and name your campaign.

      4. Select the platform and page type where you want to add your widget. Then, click the Create button.

      Your title goes here
      If you have not configured your page links before, make sure to complete the configuration before selecting a page type.

      5. Configure your segments for a narrowed-down audience.
      6. The page type you select at the beginning is selected by default. In addition to this, you can customize your rules. You can also configure Display Time to set when the widget will disappear.

      7. Go to the Design step and add a new variant.

      Your title goes here
      API-based smart recommender does not require any visual design on InOne. For this reason, you are not directed to the Actipon Builder.

      8. Configure your recommendation settings.

      • Define the number of products to display in your campaign.
      • Check the Shuffle Recommended Products box if you want to reorder the recommended products.
      • Select a recommendation strategy.
      • Enable exclusions if needed.
      • Add filters not/to display specific products.
      • Click the Create button to complete creating your variant.

      10. Set a traffic allocation to display your variant. 

      Your title goes here
      With the API-based campaign type, you can display your campaign to a specific group of users even though you have the widget HTML on all pages of the same kind.

      11. Configure your goals.
      12. On the launch step, configure your language selection, activation time, display settings, and advanced settings as applicable.
      13. Save your campaign on the Active status.

      2. Integrate your widget to Insider's Smart Recommender API

      Now that you have created your API-based smart recommender widget, you need to integrate it into Insider's Smart Recommender API to run your campaign.

      Your title goes here
      You need to integrate your widget to Insider's Smart Recommender API to finalize your campaign creation, or it will not be displayed to your users. To complete your integration, refer to Integrating API-Based Smart Recommender

      Was this article helpful?


      ESC

      Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses