Documentation Updates

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.


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


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.


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.


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.


Did this page help you?