Engagement API lets you track website activity and connect external systems to the platform. Any remote system can send HTTP requests to read or modify platform data.
To use the API, you need an authentication key. The features available depend on the permissions your project administrator grants.
The API processes requests in 2 ways:
- Read requests: Processed immediately.
- Write requests: Queued for later processing.
Engagement API
We renamed Exponea API to Engagement API when we moved from Exponea to Bloomreach Engagement. You might still see the old "Exponea" name in some places - treat it as the same thing as Engagement API.
What you can do with the API
Engagement API enables tracking from websites and other data sources.
Track events and data
- Real-time web tracking: Track user activity from JavaScript on your website.
- Backend tracking: Send sensitive or authoritative data directly from your servers.
- Trigger imports: Start data imports when your data warehouse finishes processing.
Access platform features
- Get reports: Retrieve calculated daily reports for third-party systems.
- Manage catalogs: Add, update, or remove product catalog data.
- Handle emails: Create and manage email campaigns.
- Export customer data: Get customer properties, recommendations, and analysis results.
GDPR compliance
- Anonymize customers: Remove personal data while keeping behavioral patterns.
- Export customer data: Provide customers with their stored data on request.
Usage limits
Don't use the API for large data operations:
- Big imports: Don't push large amounts of historical data (like years of purchase history) through the API. This violates our fair use policy. Use the Imports feature instead.
- Mass exports: Don't pull all customer data through the API. This is considered abuse. Use Data Exports or Exponea BigQuery for large datasets.
These restrictions protect platform performance for all users.
API changes and versioning
Bloomreach may modify, enhance, or replace the APIs from time to time, including by introducing new versions and deprecating or discontinuing older versions, provided that Bloomreach will not materially reduce the core functionality of the contracted services during the term without providing Customer with a reasonably equivalent alternative or, where no equivalent is available, reasonable transition support, and will provide reasonable advance notice of any deprecation that results in removal of an API. Notwithstanding the foregoing, Bloomreach may make changes without advance notice where necessary to address security vulnerabilities, comply with applicable law, or respond to changes in third-party dependencies.
Technical details
Bloomreach Engagement uses REST API across all services.
CORS issues
If you run into cross-origin resource sharing (CORS) issues when making API requests from your website, see the API requests FAQ article.