autotrackIdle

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

Learn how to configure when Altocloud detects inactivity on a webpage, so you have more accurate page tracking information for use in segments and outcomes.

Description

The autotrackIdle module tracks when and where a user becomes inactive on a webpage. To use autotrackIdle, use the following options to configure the idle events that you want to track:

Signature

ac('load', 'autotrackIdle', [config], [callback]);

Example

ac('load', 'autotrackIdle'); // This is for all one idle event config with defaults
 
ac('load', 'autotrackIdle', {
  idleEvents: [
    {}, // This is for all defaults
    { eventName: 'stuck_on_page' },
    { idleAfter: 60 },
    { eventName: 'idle_for_2_min', idleAfter: 120 },
  ]
}, function () {
    console.log('"autotrackIdle" has been loaded');
});

Config (optional)

Description: identifies an array of idle events that should be tracked.

Type: object

Properties:

Name Description Type Status
idleAfter The number of seconds of inactivity after which an event will fire.

The default is 60 seconds.

Note: The minimum is 30 seconds. If you specify less than 30, then 30 seconds is used.

Number optional
eventName A string that will be used as the event name when an element matching the selector is clicked. String optional

Example

{
  idleEvents: [
    {}, // This is for all defaults
    { eventName: 'stuck_on_page' },
    { idleAfter: 60 },
    { eventName: 'idle_for_2_min', idleAfter: 120 },
  ]
}

Callback (optional)

When a module fully loads, callback is executed. No arguments are passed to the callback.

Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/autotrackIdle (2020-08-05 01:22:40)"