Event Tracking API
Website Theme/Blueprint Required Changes
XConnect Hawksearch provides the following API to send tracking events to Hawksearch:
POST api/xconnect/v1/events/track
{
"eventType ": "<Event Enum Value>",
"eventData ": "<Base64 Encoded Event Data>",
}
The following are the values for the Event Enum Value:
- ClickEvent
- RateEvent
- BannerClickEvent
- BannerImpressionEvent
- RecommendationClickEvent
- AutocompleteClickEvent
- BannerImpressionBulkEvent
- AutocompleteTrendingCategoryClickEvent
- AutocompleteTrendingItemsClickEvent
See Known Limitations below.
For the Base64 Encoded Event Data, see the Hawksearch documentation on events (https://developerdocs.hawksearch.com/docs/event-tracking-api#tracking-event-types) for the event data object properties. The event JSON object should then be base64 encoded and sent in the “eventData” parameter as a string.
EventType Values
The following table lists the event types supported by HawkSearch Analytics and indicates whether each event is tracked automatically by the Opti Connector or requires additional implementation. A yes indicates that the event is tracked out of the box, while a no indicates that custom event tracking must be implemented by your Systems Integrator (SI).
| EventType Code | EventType Code | EventType Value | Out-of-Box? |
|---|---|---|---|
| Page Load Event | PageLoad | 1 | Yes |
| Search Event | Search | 2 | Yes |
| Click Event | Click | 3 | No |
| Add To Cart Event | Add2Cart | 4 | Yes |
| Rate Event | Rate | 5 | No |
| Sale Event | Sale | 6 | Yes |
| Banner Click Event | BannerClick | 7 | No |
| Banner Impression Event | BannerImpression | 8 | No |
| Tracking Member Login Event | Identify | 9 | Yes |
| Recommendation Click Event | RecommendationClick | 10 | No |
| Autocomplete Click Event | AutoCompleteClick | 11 | No |
| Add To Cart Multiple Event | Add2CartMultiple | 14 | Yes |
| Banner Impression Bulk Event | BannerImpressionBulk | 16 | No |
| Autocomplete Trending Category Click Event | AutoCompleteTrendingCategoryClick | 17 | No |
| Autocomplete Trending Items Click Event | AutoCompleteTrendingItemsClick | 18 | No |
Known Limitations
There is a current bug where the “Recommendation RequestID” is not returned from the recommendation API call. This is needed for the RecommendationClickEvent. This will be added in a future release of XConnect.
There is a current bug where the “IsRecommended” is not returned by the Autocomplete API call. This is needed to choose when the Autocomplete Trending events should be sent or not. This will be added in a future release of XConnect.
Banners are currently not supported by XConnect, but will be supported in a future release of XConnect.
Updated 15 days ago