Events are actions that happen (or “fire”) in your application. There are a lot of different type of events that could happen like:
- A user viewed a web page
- A user clicking on a button
- An error occurred
Pendo collects page views, click and focus type of events automatically after you successfully install. When users “click” on something in your application, you can see what they clicked on after you tag it as a Feature in Pendo. You might want to see Click Event Properties in some scenarios such as:
- Collect the value of a text field or drop down menu in a form when users click on the “Submit Form” button - use Pendo to see which dropdown options were used most (using “Group By” in Data Explorer)
- Collecting search terms when “Search” is clicked to identify the most common search terms that users are submitting (using “Group By” in Data Explorer).
- Collecting the name or SKU of an item that is added to an online shopping cart when “Add to Cart” is clicked, then using “Group By” in Data Explorer to see the most popular items your customers are purchasing.
Click Event Properties empower (non-technical) admins to tag their applications and collect additional context using Visual Design Studio. Admins can select a property on a page or in the DOM that they want to capture upon a feature click, and can create segments or even run data explorer reports leveraging these properties.
In order to enable and capture click event properties, you must have the following:
- You must have admin permission on your subscription
- Agent version 2.45.0 or higher (Learn how to upgrade your version)
Any Pendo user can use click event properties to create segments or run data explorer reports after they are tagged.
Warning: Click Event Properties can be used to collect sensitive data such as PII if misused. For this reason, tagging is restricted to users with Admin privileges.
How to enable Click Event Properties
Navigate to Subscription Settings from "Settings" option in the bottom left-hand corner.
Then, click on "enable" for Click Event Properties under the "General" section.
Clicking on "Enable" will open a confirmation message.
Because you can capture sensitive or personal data with this feature, please confirm that you intend to enable this feature by typing in "I understand" in the text box and then click on "Enable Event Properties."
Once it's enabled, any admin can navigate to the "Features" section of Pendo and navigate into Visual Design Studio to tag what Click Event Properties you want to capture.
How to Tag Click Event Properties
Tagging Click Event Properties happens within Features. To start, navigate to “features” under the “Product” section in the left-hand navigation.
Then, open the designer by clicking the “Manage in-app” button in the top right corner and enter your site’s URL to launch it.
If you haven’t tagged your feature yet, do that first. If you want to add Click Event Properties for features you already tagged, choose the feature within your list and select edit:
Navigate to the bottom of your settings and click on “Add Event Property” button.
First, name the property you want to collect.
Note: If the name consists of more than one word, you must separate the words with underscores.
For example, the proper way to name a property that shows you if a feature that has uses multiple words like "Language Selector," you would use “language_selector.” Writing “Language Selector” in the field will show an error message.
Tip: Property names are shared across subscriptions, so be sure to include an app specific name to your event property.
For example, you might have identical property names like “Country” in different apps. It’s important to give the Event Property an app specific name like “App1_Country” if you want to report on data from apps individually.
Next, tag the property you hope to collect using either CSS or JS.
Pendo recommends the use of CSS for most people because this option allows you to easily select the correct properties like form fields using "Target Mode."
Lastly, select the correct Path.
Selecting the right Path is easy if something is typed or entered into the actual field. Go ahead and type or select your option so Path options can automatically show you previews of what will be collected if you were to select that Path option.
The most commonly used Path options like “Value” and “Innertext” are listed at the top of the Paths list - simply choose the option that gives you the preview that matches what you want to collect, and then click “Apply” at the bottom of the menu.
Tip: Once your desired field is clicked, hold the “option” (or Alt for Windows users) key on your keyboard and enter some text in the text field, or selecting the correct option for things like drop down menus, boolean values and more. Doing so will make the next step of selecting the desired Path much easier.
Change a Tagged Event Property Type
Click event properties can be collected in four different data formats: String, Number, Boolean & Time/Date. By default, click event properties are collected as Strings, but it is important to categorize any click event properties you collect properly as you will not be able to create accurate segments or reports on improperly categorized data.
As best practice, categorize any newly tagged property you collect correctly immediately after tagging. This can be done by navigating to Pendo “Settings” followed by “Event Properties.”
Warning: Be sure to choose the correct category the first time. Otherwise, you will overwrite any property data collected up to that point. As a result, it’s best to categorize immediately after tagging a property for the first time.
You have the option of recategorizing event properties from this menu, but it’s important not to recategorize properties with an incorrect type.
Note: This page lists both Track and Click Event Properties.
Group by Event Property in Data Explorer
After you tagged your Features it's associated Click Event Properties, analyze your data in Data Explorer. In your data source, choose Feature Clicks or Track Events to choose "Event Property" in Group by.
Track Event and Click Event Properties using “String” formats. This allows you to see event properties in buckets, from most used/submitted to least, in one high-level view.
Note: “Group By” Event Properties in Data Explorer is currently limited to properties categorized as Strings and Boolean. We will be adding support for Event Properties that are categorized as Numbers and Time/Date in future releases.
Create a Segment Using an Event Property
You can create a segment from the filter bar or Segments Management page. To use Event Properties (Click or Track), you will need to choose an item that have Event Properties associated with it.
To create a segment using a Track Event property:
Select the Track Event associated with the property you are trying to collect and specify the number of times that Track Event is interacted with for the segment you are trying to create (most oftentimes this is designated as the number of Track Events is greater than or equal to 1).
Lastly, specify your date range. Completing the above steps exposes a new button titled “Use Event Property.” You will need to be specific with what property value you are trying to create a segment around.
To create a segment using a Click Event Property:
Select the feature associated with the property you are trying to collect and specify the number of times that the Feature is interacted with for the segment you are trying to collect (most oftentimes this is designated as the number of Feature clicks is greater than or equal to 1).
Lastly, you would specify your date range. Completing the above steps exposes a new button titled “Use Event Property.” You will need to be specific with what property value you are trying to create a segment around.
Frequently Asked Questions
What’s the difference between Click and Track Event Properties?
Track Events are actions that don't happen directly on your web application (server-side or client side). Track Event Properties will be set up by a developer. Learn more about Pendo Track Events. Click Event Properties are associated with your tagged Features so you can capture them from Visual Design Studio.
Can I use Click Event Properties in segments for Analytics?
Yes. After you tag your Click Event Property, choose the Feature your event property is associated with and select your Event Property you want to use in your segment. Learn more about how to segment using Click Event Properties ›
Can I use Event Properties in segments I’m using for Guide targeting?
Not at this time. See all ineligible segment for Guide targeting ›
Can I use Click Event Properties in Data Explorer?
Yes, you can choose a segment that uses your Click Event Property or "Group by" option. Learn more about Data Explorer ›
Are Click Event Property analytics retroactive?
No. Like Track Event Properties, Pendo will capture Click Event Properties once you tag them from the Designer so you're collecting intended properties that exclude any sensitive or personal data.
Can I disable Click Event Properties?
Yes. Navigate back to Subscription Setting and click on "Disable." Once you disable Click Event Properties, you will no longer see the top 10 properties tables in feature or Track Event details pages, the dedicated Event Properties page in Settings, choose "Event Properties" when you create a segment, or "Event Properties" in Data Explorer "Group by" option. Properties will no longer be captured after it's disabled.