This class provides RESTful services to let the marketing engine know about certain
types of events, such as CategoryDisplay, ProductDisplay, and Search.
Method Name |
HTTP Method |
URL |
Query Parameters |
Description |
Authentication |
Example |
triggerMarketing |
POST |
store/{storeId}/event/ |
responseFormat={responseFormat} |
This REST API lets the marketing engine know about an event. The parameters that are included
on the REST event call are the details of the event:
- DM_ReqCmd
- The command name.
- personalizationId
- The personalization ID of the current user.
- <additional parameters>
- All the other name-value pairs from the current URL.
This API informs the marketing engine about events for 3 main customer browsing scenarios:
- When a customer views a product display page.
- When a customer views a category display page.
- When a customer searches in a store and views a search results display page.
For these main scenarios, include the following parameters and values:
- For viewing a product display
page:
DM_ReqCmd=ProductDisplay
productId={productId}
personalizationId={personalizationId} For
example:store/10202/event?DM_ReqCmd=ProductDisplay&productId=12345&personalizationId=123456789-12
- For viewing a category display
page:
DM_ReqCmd=CategoryDisplay
categoryId={categoryId}
personalizationId={personalizationId} For
example:store/10202/event?DM_ReqCmd=CategoryDisplay&categoryId=12345&personalizationId=123456789-12
- For viewing a search results display
page:
DM_ReqCmd=SearchDisplay
searchTerm={searchTerm}
personalizationId={personalizationId}
For
example:store/10202/event?DM_ReqCmd=SearchDisplay&searchTerm=shoes&personalizationId=123456789-12
|
No,HTTP |
Sample
|