What is Activity Tracking and why is it used?
Activity Tracking is used to define the expected action pattern required to perform some Activity within the host application. For example, to complete a simple login, a user performs a set of actions. Once the login page is loaded, a user typically:
1. Types in an email or user name in the Username field.
2. Types in a password into the Password field.
3. Clicks the Login button.
To "remember" the course of a seemingly simple procedure the following data should be collected:
- Each user action is considered to be a system event,
- Each element a user interacts with passes various properties to Apty with the aim of identifying each element in a unique way (ID, class, relationship with other page elements, etc.)
In essence, Activity is a combination of a user's step-by-step actions in the host application, which are registered by tracking events and properties identifying the elements that a user interacts with.
How to access the Activity tracking option in the Apty Studio?
Apty Activity Tracking can be accessed by installing Apty Studio that connects to the browser with an open hosting application for an Admin user to create a blueprint of a certain Activity or, in other words, the scenario for desired flow of user actions.
1. Login to the the Apty Studio and select the hosting application you plan to work with. The Studio menu opens.
2. Click on the Activity tracking icon.

Step 1: Click on Create New Activity
On the Activity Tracking page click Create New Activity or the +(Plus) button at the top right corner of the screen.
Step 2: Start to capture
a. Click Start Capture.
Info:
![]()
![]() |
b. Continuously capture the events required and click Recording to stop capturing events.
Note: Click Resume Recording to add more events. ![]() |
c. Click Continue.
Step 3: Add a Name
Add a Name for the actions captured and click on Save.
NOTE: To Re-select the events in Activity, refer to Add/Modify Activity Events. |
Step 4: Click on Add Conditions
Click on Add condition, here clients or partners can add business process-compliance conditions/rules to streamline the flow of Events. Apty provides options for multiple type of rules from which the clients or partners can select from,
-
On Screen Element: Clients or partners can add CSS selector for the required element which needs to be considered for the activity tracking from the Developers console and select the required operator from the Select Operator dropdown to define a condition.
-
Storage: By collecting the necessary storage key details from Developers console (under Application section) and by selecting the required operator from the Select Operator dopdown then adding the respective value for the key a condition can be defined. Apty provides option to add Windows variable, Local Storage, Session Storage or Cookies Storage as Storage type to track the Activity.
-
Page: With this, Apty's clients or partners can define a condition for an activity by adding the page properties such as Page URL, Page language, Page path, Timezone, etc. from the Page property dropdown then select the required operator and add its respective value.
-
Device: This condition can be used if clients or partners want to track the activity of the user based on the device they are using to complete the task. By adding the device properties such as OS version, Browser name, Browser version, etc. from the Device property dropdown then select the required operator and add its respective value to define the condition for the activity.
-
Date and Time: This condition can be used if clients or partners of Apty need to define the activity based on date and time. Any date or time which is out of the range for the added condition then the activity will be considered to be failed.
-
Activity Events: Apty's clients or partners can track the activity based on the events present in the activity. User can either select for Event value or Augmented data options, when Event value is selected user can define the condition based on events available for that activity. When Augmented data is selected user needs to define a custom JS from Data Augmentation section and need to enter the JSON key value returned from the script to define a condition.
-
Segments: User can either select for Segments or Segmentation data options, when Segments is selected user needs to define the condition based on the list of segments which are already created and available in the admin console. But when Segmentation key is selected user needs to enter the JSON key value returned from the script in Custom JS section in Admin console to define a condition.
-
Custom JS: User can add the condition by writing any custom JS and if it returns true it will be considered as a valid activity.
-
Now in Execute On section, users or clients can select the exit point in which this conditions/rules needs to evaluated in the defined activity.
![]() |
![]() |
![]() |
![]() |
Step 5: Click Save.
Add Optional Start Step to an event
The Optional Start Step allows you to define when and which Activity is considered to have begun. In the following example, the New event is declared as the Optional Start Step to ensure that the Activity Tracking for creating a new Lead in Salesforce only begins when the New event is clicked.
To add Optional Start Step to an event,
1. Click Edit Events to find all the captured events.
2. Click the ellipsis on the event you want to declare as the Optional Start Step.
3. Click Optional Start Step.
Add a Cancel Event
To track how frequently an Activity has been cancelled, declare an event as the Cancel Event for that Activity.
To specify an event as a Cancel Event,
1. Click Edit Events to find all the captured events.
2. Click the ellipsis on the event you want to declare as the Cancel Event.
3. Click Cancel Event.
Info: Once you select an event as the Cancel Event, the Optional Start Step, Mandatoy, and Exit Point options are disabled for that event. |
Add Exit point to an event
1. Click Edit Events to find all the captured events.

2. Click the ellipsis against the respective event and click Exit Point option from the dropdown.
Make an event Mandatory
Clients or partners can make any event as Mandatory in the activity created, if they needed to check the activity of user for any specific important event.
If an event is marked as mandatory and if user moves without using this event, it will be recorded as Incomplete Activity in the Insights. By following the below steps clients or partners can make any event as Mandatory,
1. Click Edit Events to find all the captured events.

2. Select Mandatory
Click the ellipsis dots against the respective event and click on Mandatory option from the dropdown.

To add Action for event
With Event Action feature clients or partners can define the type of action needed over the selected event. By default, Apty provides three options such as Click, Change, and Hover.
For instance, if the event action is selected as Click then the activity will be recorded if the user clicks over the selected event. Follow the below steps to add Event Action for an event,
1. Click on Edit Events
Click on Edit Event to find all the captured events.

2. Select the Event Action
Click the ellipsis against the respective event and from the dropdown click on Event Action option, now select the type of event action required.
How can we access the Activity created?
Activities can be accessed within the Apty Insights Admin > Activities and can be recaptured or deleted at any time. To know about Activity engagement in Apty Insights Admin, refer to Apty Insights-Admin Panel Overview.
Info: To delete Activity, refer to Delete Event/Activity article. |
Comments
0 comments
Please sign in to leave a comment.