Platform X
Search…
⌃K

Web event specificity

Fields automatically added to event

The JS SDK and Web container add specific properties in the event regarding the browser. Event playload example :
{
"event_name": "search",
"event_id": "202110130000000000", //Automatically added
"properties": { // event properties you set
"search_term": "t-shirts",
"url": "https://www.mywebsite.com/path1/path2/",//Automatically added if missing
"path": "/path1/path2/",//Automatically added
"referrer": "https:///www.google.fr",//Automatically added
"title": "My page title",//Automatically added if missing
"user": {
"id": "12345",
"email": "[email protected]",
"consent_categories": ["1", "3"] //Automatically added if CA CMP
}
},
"page": { //Automatically added
"title": "Search page",
"url": "https://shop.com/search?q=...",
"lang": "en",
"referrer": "https:///www.google.fr",
"viewport": {
"width": 320,
"height": 568
}
},
"device": { //Automatically added
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36",
"ip": "102.3.4.56",
"lang": "fr",
"cookie": "_fbp=123; _fbc=456; _ga=789",
"timezone": "Europe/Paris"
},
"event_timestamp": "1639044446636", //Automatically added
"generatorVersion": "10.0", //Automatically added
"containerVersion": "3.1" //Automatically added
}

Fields automatically added

Field name
Example value
Description
device.user_agent
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36
The browser's user agent
device.lang
fr
Browser language
properties.path
/path1/path2/
Path of the current url (only on page_view)
properties.referrer
Referer url (only on page_view)
properties.title
My page title
Title of the current page (only on page_view)
properties.url
Url of the current page
page.*
pages information
(*) IP Address is not collected by our libraries, but instead filled in by our servers when it receives a message for client side events only.