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 :

  • ClickEvent
  • RateEvent
  • BannerClickEvent_
  • BannerImpressionEvent*
  • RecommendationClickEvent+
  • AutocompleteClickEvent
  • BannerImpressionBulkEvent*
  • AutocompleteTrendingCategoryClickEvent%
  • AutocompleteTrendingItemsClickEvent%

See Known Limitations below

For the , 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.

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.