ClientEventMetadata

In order to correctly model certain types of client events, a clientEventMetadata object must be specified.

These types of client events, and their corresponding metadata objects, are documented below.

ClientEventAdMetadata

Required for all events with the following ClientEventType

AdImpression
AdInteraction

Category sections, Curation sections, and Client Events

While categoryId and curationId are not explicitly required by the Client Events endpoint, it is your responsibility to include them whenever you want to correctly attribute Ad impressions and interactions to their applicable category and / or curation.

Property	Type	Description	Required
serveToken	string	Serve token which was originally returned with the ad	No
section	Section	ID pertaining to the FI-specific section of the UI where the event took place. For example, if the event took place in a “Featured Offers” section with a sectionId of `5`, the event’s sectionId should be set to `5`	Yes
channel	Channel	Channel through which the ad was delivered	Yes
imageSlots	string[]	Array of string values indicating the position or type of image	No
categoryId	string	ID of category associated with Ad event. Applicable whenever an Ad Impression or Interaction takes place within a collection of Ads grouped by category. Example: a user taps on or activates an Ad in a "Grocery" category collection.	No
curationId	string	Same guidelines apply as with `categoryId`. Include this when a user activates or interacts with an Ad as part of a curation collection. Example: a user taps on or activates an Ad in a "Back to School" curation collection.	No
displayPosition	integer	A zero-indexed integer representing the position of an ad if it was presented as part of a category, curation or other logically grouped aggregate	No
price	null

ImageSlots

Note that imageSlots can be a list of values, such as "logo", "largeRectangle", "smallRectangle", indicating the position or type of image, like this:

        "logo",
        "largeRectangle"
     ],
"imageSlots": [
        "logo"
     ],

Example

{
   "requestId": "5a7d1891-c212-492e-a17f-b41af1ebc1b2",
   "requestTimestamp": "2024-04-18T12:30:54.223471415Z",
   "source": "API",
   "clientEventId": "c262c8bf-4368-4a2a-b003-713e36ad3fcd",
   "clientEvent": "ActivateOffer",
   "clientEventType": "AdInteraction",
   "clientEventTimestamp": 1713443454113,
   "clientEventMetadata": {
      "section": "Summary",
      "channel": "MobileApp",
      "adId": "1000053739",
      "serveId": "0cb17ca6-441a-4369-89c9-740e29dd16ea",
      "serveTimestamp": 1713443436163,
      "categoryId": "",
      "curationId": "",
      "displayPosition": null,
      "price": 0,
      "imageSlots": [
         "logo"
      ],
      "adsLayout": null,
      "experimentId": null
   },
   "institutionId": 7096,
   "customerId": 14,
   "cdwCustomerId": 70960000000014
}