URL

get

URL getter that will return the URL that will be used by the Agent to describe all data events collected for this app and for Guide requests. This URL can differ from the browser's URL based on customizations made by the host application. The URL customizations can be learned about here.

Example

var url = pendo.url.get();

getCurrentUrl(name, reason) ⇒ string

Returns the normalized URL sent from the backend with the guides payload. This won't always match the desired output from the customer's url customizations if using location API.

Returns: string - URL

Param	Type	Description
name	string	name of the guide to display
reason	string	optional reason for the display

Example

pendo.getNormalizedUrl()

Example

pendo.normalizedUrl

Example

pendo.getCurrentUrl()
/**
Activates the Guide for the given name, if loaded. If it is not in the payload,
this function will return false.

Example

pendo.showGuideByName('guide_name')

getNormalizedUrl() ⇒ string

Returns the normalized URL sent from the backend. This won't always match the desired output from the customer's url customizations if using location API.

Returns: string - URL

pageLoad([url])

Registers a new load event. Collects only if the URL has changed.

Param	Type	Description
[url]	string	if not provided, defaults to the current URL from the browser

Example

pendo.pageLoad()