analytics
module for Fender JS Utilities
Installation and Usage
yarn add @fenderdigital/analytics --save
import analytics from '@fenderdigital/analytics';
List of functions in module
getCommonTrackProperties
track
trackAuthUser
trackPage
getCommonTrackProperties
Description
Tracking properties to be include on all tracking calls.
Function parameters
-
siteId
- default site id value -
properties
- tracking properties included in calls
paramName | paramType | defaultValue |
---|---|---|
siteId | string | com |
properties | object | {} |
track
Description
Tracks events for user actions and error handling.
Function parameters
-
eventType
- type of event -
properties
- tracking properties included in calls -
siteId
- default site id value
paramName | paramType | defaultValue |
---|---|---|
eventType | string | null |
properties | object | undefined |
siteId | string | undefined |
trackAuthUser
Description
Tracks an authorized user during sign-in or sign-up.
Function parameters
-
properties
- tracking properties included in calls -
siteId
- default site id value
paramName | paramType | defaultValue |
---|---|---|
properties | object | undefined |
siteId | string | undefined |
trackPage
Description
Tracks the page a user is on.
Function parameters
-
siteId
- default site id value
paramName | paramType | defaultValue |
---|---|---|
siteId | string | undefined |
Development
Check the Monorepo README for development documentation.