The Engagement APIs let 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 APIs, you need an authentication key. The features available depend on the permissions granted by your project administrator.
The APIs process requests in 2 ways:
- Read requests: Processed immediately.
- Write requests: Queued for later processing.
Note
The Engagement APIs were formerly called the Exponea API. Any references to "Exponea API" refer to the same thing.
What you can do with the APIs
The Engagement APIs enable 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 APIs for large data operations:
- Big imports: Don't push large amounts of historical data, such as years of purchase history, through the APIs. This violates our fair use policy. Use the Imports feature instead.
- Mass exports: Don't pull all customer data through the APIs. This is considered abuse. Use Data Exports or Engagement 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. This includes introducing new versions and deprecating or discontinuing older versions. Bloomreach will not materially reduce the core functionality of contracted services during the term without providing a reasonably equivalent alternative or, where no equivalent is available, reasonable transition support. Bloomreach will also provide reasonable advance notice of any deprecation that results in the removal of an API.
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 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.