This reference guide represents the fields collected when the Enable Tracker setting in Module Settings is enabled. The tracker collection stores individual records for each interaction that was tracked on the client side.
To learn more about the Enable Tracker setting, view our Module Settings article.
The documents in the collection can have the following fields:
Property Name | Description |
|---|
_id | Unique Mongo ID for each tracker document. |
application | The unique identifier of the module or workflow that created the submission. |
component | The component key that the user interacted with. |
componentPrevious | The previous component that the user interacted with. |
context | When a parent module dynamically refreshes in a child module, if a user interacts with a component in the child module, this field includes the ID of that child module. The resource field always includes the parent module ID. |
resource | The form that the user interacted with. This value changes across tracker documents for a submission if the user is viewing the submission across different forms. |
sessionId | The unique identifier of the user’s session. This value is always available in the tracker document. |
submission | The submission ID for the user. This value is only available if the submission is created. |
submissionSessionId | The unique identifier of the session before the submission is created. It can be used to see which actions were taken for a submission before the submission save occurred. |
timeElapsedPrevious | The time elapsed since the last user interaction. |
timestamp | The ISO timestamp of the interaction. |
type | The type of interaction, like focus, blur, or click. |
url | The URL of the current page. |
user | The unique identifier of the user who made the interaction |
userAgent | The browser user agent. |
value | The value of the component at the time of the interaction |
A URL (uniform resource locator) is a unique identifier used to locate a resource on the internet. Also known as a web address.