Build site experience and send events
Phase objective: Build the website's front-end search experience and implement tracking.
Key tasks
What you do
- You design and deploy the site experience.
- You implement and validate the tracking pixel.
What we do together
- We review your API deployments.
1. Build the site experience
1.1 Design the website user experience
Design the desired website user experience with your project team. Identify the website pages to be powered by Bloomreach.
1.2 Deploy Bloomreach APIs: Search and Category, Autosuggest, Recommendations and Pathways
Define the parameter values and deploy the APIs for the features you want to integrate on your site:
- Product search
- Content search
- Category search
- Bestseller search
- Recommendations and Pathways
- Autosuggest
SEO features (if in-scope for implementation)
Developer tools
Explore Discovery Web Code Samples showcase to seamlessly implement core Bloomreach capabilities like Search, Autosuggest, and Recommendations.
If you're using Javascript, check out our Discovery Web SDK. You may also check out our OpenAPI Specifications.
We use RESTful APIs to provide data for features on your mobile and desktop pages. These APIs are performed over HTTP 1.1 protocol, and the response is JSON-formatted.
The APIs you use depend on the features you want to integrate on your site. The Bloomreach Technical Consultant will review these features with you during the kickoff. If you decide to change these features after kickoff, let your Bloomreach representative know.
You can work on the APIs concurrently or sequentially, as you prefer. Bloomreach helps review your API deployments.
1.3 Implement facet and sort filters
You must use the correct facets, sort filters, and required fields to be returned on the Bloomreach API using the Bloomreach dashboard. Refer to our documentation on Faceting, filtering and sorting.
1.4 Test and deploy
Test the Search features and Category pages powered by Bloomreach APIs. First, debug and validate issues in the staging environment, then deploy changes to the production.
API Reference
To learn about the Discovery APIs and details on the endpoints and supported parameters, visit the API Reference.
2. Implement events tracking
-
The Bloomreach integration team helps determine the pixel tracking requirements.
-
You add the pixel to all pages, including mobile, desktop, and tablet pages, either by adding the pixel code to your website or using a Tag Manager. Deploy the Bloomreach pixel first on the development environment of the website.
-
Define and map the parameters of the JavaScript tracking pixel and add events to track specific actions people take on your website. Check the demo code sample that demonstrates how to instrument the pixel.
-
You validate the pixel deployment. Start tracking the test pixel data using Events Management.
-
Resolve pixel issues and learn how to track debug events in integration mode.
Resource library
OpenAPI Specifications (OAS) for Discovery Delivery APIs offer specifications of Bloomreach APIs in a standardized format that can be used by both developers and automated tooling to generate documentation, produce client code in different languages/frameworks, create language types and models, and more. |
Discovery API Documentation |
Faceting and filtering |
Sorting |
Search Use Cases |
Discovery Web SDK |
Discovery Web Code Samples |
Pixel Overview |
Pixel Reference |
Pixel Checklist |
Events Management |
Track Debug Events in Integration Mode |
Bloomreach Pixel Validator |
Validating Pixels |
Recommendations and Pathways Integration |
Mobile Pixel Integrations: Android | iOS |
Updated about 1 month ago