Cloudflare Docs
Zaraz
Cloudflare Docs
Zaraz
Search icon (depiction of a magnifying glass)
GitHub icon
Visit Zaraz on GitHub
Set theme to dark (⇧+D)

Zaraz event and system properties

Cloudflare Zaraz offers event and system properties that you can use when configuring the product. They are helpful to send data to a third-party tool or to create triggers as they have context about a specific user’s browser session and the actions they take on the website. Below is a list of event and system properties, how can you access them, and their values:

System properties

PropertyTypeDescription
{{ system.page.query.QUERY_PARAM }}StringReturns the value of a URL query parameter. Replace QUERY_PARAM with the name of your parameter.
{{ system.page.title }}StringReturns the page title.
{{ system.page.url.search }}StringReturns search parameters provided, beginning with the leading ? character.
{{ system.page.url.pathname }}StringReturns the path of the URL, including the initial /. Does not include the query string or fragment.
{{ system.page.url.port }}StringReturns the port number of the URL.
{{ system.page.url.hostname }}StringReturns the domain of the URL.
{{ system.page.url.host }}StringReturns the domain (that is the hostname) followed by a : and the port of the URL (if a port was specified).
{{ system.page.url.password }}StringReturns the password specified before the domain name.
{{ system.page.url.username }}StringReturns the username specified before the domain name.
{{ system.page.url.protocol }}StringReturns the protocol scheme of the URL, including the final :.
{{ system.page.url.origin }}StringReturns the origin of the URL, that is its scheme, its domain and its port.
{{ system.page.url.href }}StringReturns the origin of the URL, that is its scheme, its domain and its port.
{{ system.page.url.baseDomain }}StringReturns the base domain part of the URL, without any subdomains.
{{ system.page.referrer }}StringReturns the page referrer from document.referrer.
{{ system.page.encoding }}StringReturns the document character encoding from document.characterSet.
{{ system.cookies.NAME_OF_COOKIE }}ObjectReturns cookies obtained from the browser document.
{{ system.device.ip }}StringReturns the incoming IP address.
{{ system.device.resolution }}StringReturns screen resolution for device.
{{ system.device.viewport }}StringReturns the visible web page area in user’s device.
{{ system.device.language }}StringReturns the language used.
{{ system.device.user-agent.ua }}StringReturns the browser’s user agent.
{{ system.device.user-agent.browser.name }}StringReturns the browser’s name.
{{ system.device.user-agent.browser.version }}StringReturns the browser’s version.
{{ system.device.user-agent.engine.name }}StringReturns the type of browser engine (for example, WebKit).
{{ system.device.user-agent.engine.version }}StringReturns the version of the browser’s engine.
{{ system.device.user-agent.os.name }}StringReturns the operating system.
{{ system.device.user-agent.os.version }}StringReturns the version of the operating system.
{{ system.device.user-agent.device }}StringReturns the type of device used (for example, iPhone).
{{ system.device.user-agent.cpu }}StringReturns the device’s CPU.
{{ system.misc.random }}NumberReturns a random number unique to each request.
{{ system.misc.timestamp }}NumberReturns Unix time in seconds.
{{ system.misc.timestampMilliseconds }}NumberReturns Unix time in milliseconds.

Event properties

PropertyTypeDescription
{{ client.__zarazTrack }}StringReturns the name of the event sent using the Track method of the Web API. Refer to Zaraz Track for more information.
{{ client.<KEY_NAME> }}StringReturns the value of a zaraz.track() eventProperties key. The key can either be directly used in zaraz.track() or set using zaraz.set(). Replace <KEY_NAME> with the name of your key. Refer to Zaraz Track for more information.