The Engine API

Articles

Engine API Checklist
Use this worksheet to keep track of your progress while you implement Monetate on your site. Internal Version Client to pay for SSI Email Support to enable Omnichannel experience for account Hold demo meeting with all stakehold...
What Is the Engine API?
The Engine API is a RESTful API that serves as a direct entry point to Monetate's decision engine and allows clients to use it in any channel: Web (server-side or within the browser), mobile applications, SPA frameworks, and nontraditional imp...
Types of Implementations
The Engine API was developed to be used across all channels, such as websites, mobile applications, client-telling apps, in-store displays, SMS services, or any other medium. Hybrid Implementation When used within a website, the En...
Calling the Engine API
Complete technical documentation for the Engine API is available within the Monetate platform by navigating to Settings > API Documentation > Engine API . Request Requirements When an Engine API request is ma...
Create an Omnichannel Experience
Regardless of the channel that you want to serve an experience on (mobile app, server-side integration for Web, etc.), the process for creating an Engine API experience is the same with the exception of the actions available for the experi...
Target, Event, & Condition Mapping
If your site leverages the Engine API, you must ensure to include in Engine API requests the information necessary for WHO targets and action conditions. Complete technical documentation for the Engine API is available in the Moneta...
Available Omnichannel Actions
Omnichannel action templates are used with the Engine API as well as for other usages. Contact your dedicated Services team members to request Omnichannel action templates be added to your account or to scope potential custom action template...
Example Request with Annotations
The following code shows an example request. Each object is described separately below. { "deviceId": "IMEI-123456789", "monetateId": "2.309132816.1519728587304", "preview": "6.3.eJ...
Implement Third-Party Analytics with the Engine API
Monetate's Engine API provides you with a mechanism for returning experience metadata that you can use in third-party analytics platforms in the form of the includeReporting flag. { "eventType": "monetate:decision:Decisio...