Skip to main content
Version: 4.62

trackEvent

Reports a specific event (i.e. an user interaction or success or failure of an action) with the provided information to a connected analytics service like Firebase Analytics or Matomo Analytics.

Field Configurations

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"action"StringAction of the event.null
"async"BooleanSpecifies whether the action should perform asynchronously.null
"deviceId"StringDevice-ID of the event (UWP only)null
"id"StringID of the event (UWP only).null
"label"StringLabel of the event.null
"name"StringName of the event (UWP only).null
"timestamp"StringTimestamp of the event (UWP only).null
"user"StringUser of the event (UWP only).null

Inherited

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType name of the action.null

Examples

Example: track event

Show ExampleHide Example

Track event which has openBrowser action.

{
"type": "trackEvent",
"params": {
"action": "openBrowser",
"label": "Opened website"
}
}

The actions to be executed are specified in the actions parameter, in this case a trackEvent action.