Skip to main content

URL

Members

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.

Functions

getCurrentUrl()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.

pageLoad([url])

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

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.

Kind: global variable
Category: URL
Access: public
Example

var url = pendo.url.get();

getCurrentUrl() ⇒ 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.

Kind: global function
Returns: string - URL
Category: URL
Access: public
Example

pendo.getNormalizedUrl()

Example

pendo.normalizedUrl

Example

pendo.getCurrentUrl()

pageLoad([url])

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

Kind: global function
Category: URL
Access: public

ParamTypeDescription
[url]stringif not provided, defaults to the current URL from the browser

Example

pendo.pageLoad()