Skip to main content

Built-in Params

Definition​

This document provides a detailed walkthrough of the built-in params fired by Pulse SDK

Built-in Params list​

  • previous_url: string
  • referrer: string
  • tab_id: string
  • url: string

previous_url​

Indicates the previous URL of the page at the time the event occurred. The Pulse SDK retrieves information from sessionStorage. After navigation, the SDK stores the previous page URL in sessionStorage under the 'paa_last_location' key.

referrer​

Indicates the URL of the web page that directed the user to the current page. It shows the address of the previous page from which a link was followed to navigate to the current page. If the user arrived at the current page directly (e.g., by typing the URL in the browser or through a bookmark), document.referrer will be an empty string. Pulse SDK retrieves this information from document.referrer browser API.

note

Note: It's important to note that document.referrer may not always provide information, especially for resources loaded from different origins or under certain security settings. Some resources, such as those loaded over HTTPS or from different domains, may restrict the referrer information for privacy and security reasons.

tab_id​

Shows the tab ID of the page where the event occurred. When a new tab is opened, the SDK generates a new tab ID and stores it in sessionStorage. If an event occurs, the SDK retrieves this information from storage and includes it in the event.

url​

Indicates the URL of the page at the time the event occurred. Pulse SDK gets the url information from window.location.href browser API.