Feature Click Event Properties Overview

Overview

Click Event Properties are data collected from elements in the UI or events during a Feature click event. This empowers Admins to tag their apps and gain additional context from the UI without requiring coding or Track Events to collect additional parameters. The Click Event Property captures the targeted object and its value. Properties can be tagged using CSS to capture UI elements or Javascript to capture objects and their properties. Up to five Click Event Properties can be added per tagged Feature.

Click Event Properties have uses throughout Pendo. They are visible in Feature Details in Product Insights and Event Properties Settings. Segments can use Click Event Properties and their values in Product and Behavior Insights. Data Explorer reports can Group By properties with less than 200 Values. Guides cannot be triggered by Click Event Properties.

Click Event Property data can be used to understand the context for a user click when variables on the page or user selections change during their workflow. You can collect the value of a text field or dropdown menu when a form is submitted. Collect query terms in a search bar to identify the most common search terms. Collect the name or SKU of an item when it's added to a cart.

Click Event Properties are not collected retroactively due to the complexity and sensitivity of the possible data. Click Event Properties can be used to collect text from the UI, even user-entered text, when text collection is disabled in the Agent. This information is valuable for understanding user behavior in detail but may present a security concern if Personally Identifiable Information (PII) is present in the UI. Only Pendo Admin users can activate Click Event Properties for the Subscription and tag Click Event Properties. Data collection for Click Event Properties does not begin until the property has been tagged.

Warning: Click Event Properties can be used to collect text from the UI even if text collection is disabled in the Agent. This feature should be used carefully if there are PII or security concerns with storing UI text. Pendo does not collect any Click Event Property data until an Admin user in the Subscription tags the Click Event Property.

 

Requirements

Any Pendo user can use Click Event Properties to create Segments or run Data Explorer reports after they are tagged

 

Enable or Disable Click Event Properties

Click Event Properties activation is in the General tab in Subscription Settings. This setting controls Click Event Properties for all apps in the Subscription. 

SettingSubSettings.png

 

Click Enable next to Click Event Properties

EnableClickEvent.png

 

Read the disclosure and confirm if you want to activate Click Event Properties.

mceclip1.png

 

Pendo can capture sensitive or personal data with this feature, please confirm that you intend to enable this feature. Type "I understand" in the text box and then click Enable Event Properties.

Once Click Event Properties is enabled, any admin user can tag Click Event Properties when tagging Features in the Visual Designed Studio.

 

Disable Click Event Properties

Click Event Properties can be disabled from the General tab in Subscription Settings. This change impacts all Apps in the Subscription. This stops all Click Event Property data collection and removes Click Event Properties features from the Pendo UI. Previously collected data is still visible. Turning Click Event Properties back on resumes data collection and access to previously tagged Click Event Properties. There are no retroactive analytics for disabled Click Event Properties.

 

Click Disable to turn off Click Event Properties.

CEPDisableButton.png

 

Click Disable on the Warning message to confirm the change.

CEPDisable.png

Note: To permanently delete Click Event Property data, contact your Pendo Representative.

 

Tag a Click Event Property

Tag Click Event Properties while tagging or editing Features in the Visual Design Studio. A Feature can have up to five event properties tagged with it.

 

1. On the Features page, click Manage Features In-App to open the Visual Design Studio.

ManageFeaturesInApp.png

 

2. Tag a Feature if you haven't tagged the Feature yet.

TagFeature.png

 

3. If the Feature is already tagged, find the Feature within your list and click Edit FeatureEdit.png. Features cannot be edited while they are processing.

EditFeature.png

 

4. Click Event Properties. At the bottom of the Edit Feature modal, click Event Properties. 

EventPropertiesMenu.png

 

5. Click + Event Property to add a new Click Event Property.

_EventProperty.png

 

6. Name the property you want to collect. This is a required field and should be unique across all apps. Names must use lowercase letters, numbers, or underscores only. Any other characters will generate an error message. The name cannot start and end with two underscores, for example "__eventproperty__". This format results in an error message.

CEPNameError.png

  • A feature that has uses multiple words like "Language Selector," should be entered as “language_selector.” Writing “Language Selector” in the field will show an error message.
  • 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 multiple apps.

CEPName.png

 

7.  Tag the Source and Value you want to collect. CSS targeting can be used to narrow down the list of properties in the Values field. Use Javascript to target a property directly. Value populates with a list of available properties for the tagged Feature or targeted CSS element.

CEPSource.png

 

  • Pendo recommends the use of CSS for most people. This option allows you to easily select the correct properties, like input fields, using Target Mode. For more information on custom CSS tagging see Advanced Feature Tagging.
  • Selecting the right value is easier if something is typed or entered into the actual field. The Value options automatically show you previews of what will be collected if you were to select that option.
  • The most commonly used value options like “Value” and “Innertext” are shown at the top of the list. Choose the option that gives you the preview that matches what you want to collect.
  • The Value field supports modifiers to the selected property. For example, innerText returns the text contained in the element and adding innerText.length returns the number of characters in the text.

CEPInnertextlength.png

Tip: Common Value Fields for text collection are "innerText" or "textContent"

 

9. Preview shows an example of the Value collected by your Property if it's currently visible in the Visual Design Studio.

Example of Tagged Click Event Property

CEPTaggedEventProperty.png

 

10. Click Apply to save the new Event Property.

CEP6.png

 

11. Click + Event Property again to add up to five Event Properties per feature.

CPEAddMre.png

 

12. Save Changes to the Feature to add all Event Properties and begin collecting data for the Click Event Properties. When tagging a new Feature, add all Event Properties prior to saving Feature changes. New Feature tags begin processing as soon as they are saved and you can't edit it again until processing is complete.

CEPSaveChanges.png

 

Edit or Delete a Tagged Click Event Property

Event Properties can be edited or deleted from the Event Properties menu in a tagged Feature.

Click the FeatureEdit.png Edit button to open the details of the Event Property and make changes.

CEPEdit.png

 

Click the CEPTrashIcon.png Delete button to permanently delete the Event Property.

CEPDeleteButton.png

 

If the delete button was clicked accidentally, click Restore to undo.

CEPdelete.png

 

Click Save Changes to update the Feature with any Event Property changes or deletions.

  • Deleted Event Properties will not be available in analytics and will no longer count against the five Event Property limit for the Feature. You can reopen the Feature and tag a new Event Property if you were previously at the five property limit.

 

Change a Tagged Event Property Type

Click Event Properties can be collected in four different data formats: String, Number, Boolean, and Time/Date. Click event properties are collected as Strings by default, but it is important to categorize any Click Event Properties properly as you will not be able to create accurate Segments or reports using improperly categorized data. 

As a best practice, categorize any newly tagged property immediately after tagging. This can be changed in Event Properties Settings

EventPropertiesSettings.png

 

Recategorize any Click or Track Event Properties from Event Properties Settings. Click on the Event Property to see the Features or Track Events associated with that Event Property.

CEPEventPropertiesDetails.png

 

Warning: Be sure to choose the correct category the first time. Changing the category overwrites any previously collected property data. It’s best to categorize immediately after tagging a property for the first time.

 

Group by Event Property in Data Explorer

After tagging your Feature's Click Event Properties, analyze your data in Data Explorer.

In your data source, choose Feature Clicks or Track Events

Data_Source.png

In Group By choose Event Property.

GroupBy.png

Track Event and Click Event Properties use 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 are currently limited to properties categorized as Strings and Boolean.

 

Create a Segment Using an Event Property

You can create a segment from the filter bar or Segments page. To use Click or Track Event Properties, you will need to choose an item that has Event Properties associated with it.

Create a Segment Using a Click Event Property

1. Select the Feature that is clicked to fire the Click Event Property you are trying to query.

2. Specify the number of times that Feature is clicked for the segment.

  • Generally this is designated as the number of Feature clicks is greater than or equal to 1 to segment all visitors who have interacted with the Feature

3. Specify the date range during which the Feature was clicked.

Completing the above steps exposes the Use Event Property button.

4. Select the Event Property.

5. Select value range and value of the event property.

You need to be specific with the property value you enter to query Event Property data with a valid statement.

mceclip5.png

Create a Segment Using a Track Event Property

1. Select the Track Event for with the property you are trying to query.

2. Specify the number of times that Track Event has fired for the segment.

  • Generally this is designated as the number of Track Events is greater than or equal to 1 to segment all visitors who have interacted with the Track Event

3. Specify the date range during which the Track Events fired.

Completing the above steps exposes the Use Event Property button.

4. Select the Event Property.

5. Select value range and value of the event property.

You need to be specific with the property value you enter to query Event Property data with a valid statement.

mceclip4.png

 

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. Click Event Properties are associated with your tagged Features so you can tag them using Visual Design Studio. Learn more about Pendo Track Events.

 

Can I use Event Properties in segments I’m using for Guide targeting?

Not at this time. See all ineligible segment for Guide targeting ›

 

Are Click Event Property analytics retroactive?

No. Like Track Event Properties, Pendo captures Click Event Properties once you tag them from the Designer. This ensures you're collecting intended properties that exclude any sensitive or personal data.