Method reference

View a list of all methods in the Journey JavaScript SDK.

Initialization methods

For complete information about a method, including signature and arguments, click the method's name.

Method	Description
init	Initializes the Genesys Predictive Engagement SDK
destroy	Stops all Genesys Predictive Engagement SDK activity and removes all tracking information

Tracking methods

For complete information about a method, including signature and arguments, click the method's name.

Method	Description
pageview	Tracks page views
record	Records custom website events
identify	Adds information to a customer
forms:track

Session methods

For complete information about a method, including signature and arguments, click the method's name.

Method	Description
api.session.getData	Returns an object that contains session information
[[ATC/Current/SDK/api.sessiongetCustomerCookieId|]]	Returns a string that contains the customer cookie Id
api.session.getId	Returns a string containing session Id

Utility methods

For complete information about a method, click the method's name.

Method	Description
serialize	Used for passing serialized data from a form.
dom - ready	Allows you specify a function handler to run when the DOM has fully loaded.
debug	Sends helpful messages to the console.

Visit API methods

Name	Description
ac('api.visit.get', callback)	Performs an AJAX request to retrieve the session data from the Genesys Predictive Engagement server. The object returned contains the most up-to-date data for the session. This is useful for monitoring live data, such as segment assigned IDs, outcome score progress, and last page viewed.
ac('api.visit.cached', callback)	Retrieves the cached Genesys Predictive Engagement session data from the browser local storage. If session data does not exist in local storage, a session will be requested via an AJAX request from Genesys Predictive Engagement. This is practical for retrieving data that doesn't change for a session, such as the visit identifier, device details, location, referrer, and marketing campaign information.
ac('api.visit.getShortId', callback)	This provides the same functionality as'api.visit.cached', but only the 'shortId' is returned. The short ID is useful as a legible reference number that can be displayed on the website.

Customer API methods

Name	Description
ac('api.customer.get', callback)	This performs an AJAX request to retrieve the visitor data from the Genesys Predictive Engagement server.