Common event data

The following are event data common across different types of events. These values can be retrieved using the Event Data variable or the getEventData API.

ParameterTypeExampleDescription
client_idstringABC_123Arbitrary ID that anonymously identifies a particular user, device, or browser instance.
currencystringUSDCurrency of the purchase or items associated with the event, in 3-letter ISO_4217 format.
event_namestringpurchaseThe name of the event.
ip_overridestring1.2.3.4The IP address of the user in IPv4 or IPv6 format.
languagestringen_usThe language for the client in ISO 639-1.
page_encodingstringUTF-8The text encoding of the page.
page_hostnamestringexample.comThe hostname portion of page_location.
page_locationstringhttps://example.comThe full document URL of the page.
page_pathstring/path/to/pageThe path portion of page_location.
page_referrerstringhttps://www.google.comFull URL of the page that referred to the user to the page where the event occurred. This is not the value of the Referrer header on the request coming into the server container.
page_titlestringHomeThe title of the page.
screen_resolutionstring1024x768Total screen resolution for the user's device. (width by height).
user_agentstringThe client's user agent.
user_data.email_addressstringfoo@example.comEmail address of the user.
user_data.sha256_email_addressstringHashed email address of the user. Learn more
user_data.phone_numberstring+15551234567Phone number of the user.
user_data.sha256_phone_numberstringHashed phone number of the user. Learn more
user_data.address.first_namestringJaneFirst name of the user.
user_data.address.sha256_first_namestringHashed first name of the user. Learn more
user_data.address.last_namestringDoeLast name of the user.
user_data.address.sha256_last_namestringHashed last name of the user. Learn more
user_data.address.streetstring123 Fake StStreet and number for the address of the user.
user_data.address.citystringCity TownCity for the address of the user.
user_data.address.regionstringCAState or territory for the address of the user.
user_data.address.postal_codestring54321Postal code for the address of the user.
user_data.address.countrystringUSCountry code for the address of the user.
user_idstringArbitrary ID that is intended to be a known identifier for a user provided by the site owner/library user.
valuenumber10Monetary value of the event that occurred.
viewport_sizestring725x345Size of the content window. Usually smaller than the screen resolution. (width by height).