Activity Table Details

This table contains details on property type and short explanations regarding the value.

Field	Type	Description
action	string	Action made by a visitor on a given target. Actions are defined by a verb. List of available actions can be customized so you can create your own verb. By default available actions include click, view, add-to-cart, remove-from-cart, purchase. Example: { 'action': 'view' }
target	JSON Object	This field is a free form object used to identify the target of an activity. For example, if the action is done on a specific product, the target key will be product and the value will be the product id. Example: { 'target': { 'product': '12345678' } } Actions can be done on several targets at the same time. For example, if you click on a search facet, the target will be the facet id and the facet value. In the example below brand is the facet id, and Dior is the value of the brand facet. { 'target': { 'facet': 'brand', 'brand': 'Dior' } }
sourceId	string	The source id from the service response that generated the list or page (search result, recommendation, ...) where the action happened. For our XO platform: recommendationId For out Fredhopper platform: responseId Example: { 'sourceId':'4505dc23-73de-4bb8-a0bc-6f7e0dc205fc' }
metadata	JSON Object	Metadata contains additional descriptive information on the target. There are 4 reserved fields:price, quantity, currency, and orderId , relevant for purchases. You can also create your own additional metadata properties, by simple adding to this object when you send your activity. You should send any relevant information about the target that you can.
metadata.price	Integer	Unit price of a target, expressed in cents.
metadata.quantity	Integer	Useful when sending a purchase action. This field is used to express the quantity.
metadata.currency	string	Currency of the price property. Currency must follow the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217)
metadata.orderId	string	The unique order id of a purchase.
segments	array of string	Segments are descriptors of the client application such as iOS, Mobile, Chrome etc.
user	JSON Object	Should contain all information regarding the user who performed the activity. Detailed information available here.
user.identities	JSON Object	Contain all user's identities expressed in key/value pairs. Example: { 'user': { 'identities': { 'ecommerceId': '12345789', 'sessionId': 'XXX123456789' } } }
user.segments	array of strings	Segments are information that you have on your side which describe types of users. Example: { 'user': { 'segments': ["client", "frequent-buyer"] } } }
user.traits	JSON Object	Traits are miscellaneous information that you want to send to Attraqt about the user. This information is sent as a free form object. As those information can be personal data, please consult the section on GDPR best practices here. Example: { 'user': { 'traits': 'gender':'male', 'age':'45' } } }
timestamp	timestamp	A timestamp of the occurrence of the activity represented in the following ISO format https://fr.wikipedia.org/wiki/ISO_8601 Example: { 'timestamp': '1977-04-22T01:00:00' }