Tracking API

👍

Welcome note

Data hub is our new upgraded platform, which we rolled out in August 2025. It offers a single unified integration for passing your data through to your Bloomreach products.

You have access to Data hub if you've implemented with Bloomreach after August 2025.

Customers who have implemented before August 2025 should follow the existing documentation for Engagement, Discovery, and Clarity.

Tracking API purpose

The Event streams tracking API is mainly for tracking from the JavaScript SDK. You can also implement directly to the API as a server-side integration (public key only with the stream_id). In the future, other Bloomreach and non-Bloomreach integrations will migrate from APIs specific to Engagement and Discovery into the Data hub API.

Server-side tracking details

The client IP address and User-Agent are crucial HTTP-level details often needed for tracking, especially for functionalities like geolocation and audience targeting based on device within Bloomreach.

📘

Note

Discovery requires the IP and user agent for proper geolocation of conversion.

When implementing server-side tracking, your server receives the original HTTP request from the user's browser. This request contains the client's IP address and User-Agent string in the standard HTTP headers. To pass this information to Bloomreach's Unified Tracking API (which serves as the endpoint for server-side integrations), you would include these details in the HTTP request your server makes to the API.

Client IP Address

The client's IP address should typically be included in the X-Forwarded-For HTTP header of the request your server sends to the Bloomreach API. This is a standard header used to pass the original client's IP address when the request passes through proxy servers. The Bloomreach system is designed to parse a client's IP address from this header; therefore, the API needs to receive it from your server initially.

User-Agent

The user's browser's User-Agent string should be included in the standard User-Agent HTTP header of the request your server sends to the Bloomreach API. This header provides information about the user's browser, operating system, and device type.

API endpoint

POST to your API endpoint: https://tracking-api.bloomreach.co/track/u/v1/batch?stream_id=STREAM_ID

• Add stream_id URL param with one from your Event streams credentials page.
• Add X-Forwarded-For HTTP header with your IP address for geolocation use cases.
• Add User-Agent HTTP header with your user agent for device audience targeting use cases.

API examples

Read more in the Event streams SDK integration pages.

OpenAPI specification files

Read more in the API reference guides.