Method reference

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Journey JavaScript SDK for version Current of Altocloud.

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 Altocloud SDK
destroy Stops all Altocloud 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  


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 Altocloud 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 Altocloud 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 Altocloud. 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 Altocloud server.
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Method_reference (2020-05-29 20:50:11)"