What is Engagement API?
Engagement API lets you track website activity and connect other systems to the platform. Any remote system can send HTTP requests to access and modify platform data.
To use the API, you need an authentication key. Once authenticated, the features available depend on the permissions your project administrator grants.
The API processes requests in 2 ways:
- Read requests: Processed immediately.
- Write requests: Go into a queue 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.
Important 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.
Technical details
REST API standard
Bloomreach Engagement uses REST API across all services.
CORS issues
If you're making API requests from your website and run into cross-origin resource sharing (CORS) problems, check our API requests FAQ article for solutions.