Documentation Updates

The Bloomreach Discovery documentation experience is even richer with exciting new improvements. Check out the latest documentation updates and articles here in week 4 of each month!

12001200

🎉 August 2022


1. Catalog Management

Catalog Management empowers technical users to view, manage, diagnose, and explore data across all the catalogs in their account. It covers the entire experience of managing the data integration process, from feeding data into a Discovery catalog all the way to configuring and verifying the data in our Search and Suggest APIs. Check out the articles below to learn more:

  1. Catalog Management feature page
    1.1 Understanding Feed & Configuring Attributes
    1.2 Promoting Changes & Viewing Jobs
    1.3 Exploring Catalog Data & Customizing API

2. SSO Documentation

We have updated our SSO documentation to answer your frequently asked questions about setting up an SSO connection with the Bloomreach IAM.

3. Discovery Developer Documentation

An interesting update for all Developers using our documentation! The Developers section has been revamped to have a new home. It now also lists down the necessary resources for help regarding all technicalities related to Bloomreach Discovery. Developers can find detailed guides for integration and other configurations, along with API references and even FAQs.

🎉 July 2022


1. Algorithm Controls Guide

The Algorithm Controls feature enables you to configure 4 of our search algorithms via API calls directly. We have created a dedicated article on how this feature works. Visit this guide to learn more about this feature's benefits, uses, and implementation.

We have also added new pieces of documentation that dive deeper into the functioning of our search algorithms. Check out the revised algorithm documentation here:

2. Recommendations and Pathways API Parameters Reference

The Recommendations and Pathways API Reference got an exciting update this month. We’ve added a new page consisting of an exhaustive list of all the parameters used in all of the Recommendations and Pathways APIs. Since a lot of the parameters are common for all APIs and a few of them are specific to some APIs, having a one-stop destination with details about every parameter can prove to be very useful for your developers.

We’ve detailed the What, Why, and How of each parameter and which APIs they can be used with. You can also find real-life example values for the parameters. Next time you need additional information on any parameter while using the Recommendations and Pathways APIs, just head over to the Recommendations and Pathways parameters reference!

3. Real-Time Customer Segments for Discovery Guide

We are excited to share the dedicated documentation for the Real-time Customer Segments for Discovery feature. This feature makes it easy to personalize search results at the most granular level by combining Engagement's powerful CDP and Discovery's extensive search algorithms. Check out the articles about this feature on Discovery and Engagement documentation.

🎉 June 2022


Pixel Monitor Phase 2 Documentation

With Pixel Monitor Phase 2 launch, you can now monitor your pixel health at the site level. Also, new pixel checks are available for Relevance by Segment and Content Search. We have added the following articles to help you learn about this feature:

🎉 February 2022


Welcome to the new home of Bloomreach Discovery documentation! Our move to Readme comes with many improvements, especially to our API documentation:

  • Improved API documentation
  • Unified documentation
  • Navigation

Improved API documentation

Readme’s Try It! feature allows you to make authenticated calls and receive real responses within the documentation. This allows your developers to explore our APIs and check if your calls are set up correctly.

Please note that this feature requires proper authentication to receive a response. We have also provided test values that you can use.

600600


Readme provides a stylized parameter reference, which better highlights each parameter and their requirements. This is also where you enter values for Try It!

18201820


Did you notice the GET tags on the left? Any page detailing operations on an API will have a matching tag in the navigation menu. This should help you find detailed API information more easily.


Unified documentation

Our new documentation site now provides unified access to documentation for each of Bloomreach’s products. Quick access is located at the top of any page.

13641364

Navigation

In addition to the migration, we have also taken this opportunity to restructure the Discovery documentation and clean up all of the pages. The page categories have been renamed and rearranged to more accurately reflect their contents, and we have removed some duplicate or redundant pages to reduce clutter. Many pages have also been revised for clarity.

Readme’s navigation menu and search function should also feel smoother. In particular, you can filter searches by product (Engagement, Content, or Discovery) and section (Guides, Reference, etc.), and search results are displayed within the documentation instead of a separate search results section. This should reduce the amount of time spent loading pages and help you find specific pages more easily.

28282828

Feedback

On our end, Readme will make it easier for us to make and manage our documentation. We hope that you find our documentation site to be more usable and friendly to your needs as well. We welcome your feedback, which you can submit at the bottom of any page.

16561656

Did this page help you?