Skip to content

Activity Tracking

The activity tracking plugin enables events that track movement and coverage activity on the site. This service is self-serving -- there are no available methods, and doesn't have any additional functionality to provide.

This plugin additionally fires events required for the backend to provide information about page coverage and timing by the user.

Installation

This plugin requires no additional installation to be used correctly.

Configuration

This plugin provides the following configuration variables:

Variable Type Required Description
heartbeatTimer integer (ms) no seconds between heartbeat events

Methods

This plugin has no public methods.

Events

Generated

This plugin generates the following events:

Action Spec Trigger
marker
{
object: 'page',
label: 'active_page_ping',
scrolls: {
xMin: 0,
xMax: 0,
yMin: 0,
yMax: 0
},
activity: {
usedMouse: clicked,
usedKeyboard: typed,
usedScroll: scrolled
}
}
Heartbeat w/ activity
marker
{
label: 'inactive_page_ping',
object: 'page'
}
Heartbeat w/o activity

Listening

This plugin does not listen for any events.

Dependencies

This plugin does not depend on any other services or plugins.


Last update: 2023-04-13