Event properties

Last updated:

Pendo keeps track of the actions visitors take within your application and saves this data as raw events. Examples of these events include when a visitor clicks on a Feature, views a Page, generates a Track Event, or interacts with a guide.

Event properties are details associated with an event at the time it takes place. You can use event properties in reports and segments to target or analyze how your visitors use your app over time.

Event property types

There are two different types of event properties: global and custom. The main difference between these two types of event properties is that global event properties are captured on every agent event, whereas custom event properties are captured on specific click events and Track Events. Both types are reviewed in further detail below.

Global event properties

Global event properties are details that are captured on every agent event that takes place in your application. There are two subsets of global event properties: device data and historical metadata.

Device data is captured on every event by default:

  • For web apps, Browser Name, Browser Version, Device Type, and Operating System.
  • For mobile apps, Device Model, OS Version, Device Type, Operating System, App Version (Customer app version), and SDK Version (Pendo SDK version).

Historical metadata is data that originates as visitor or account metadata but acts as an event property when these values are enabled as historical in Settings > Data Mappings. For more information, see Historical metadata.

Note: Device and browser usage in event properties aren't the same as the default metadata fields "Most recent browser name" and "Most recent operating system". Metadata shows the value in the last event processed by Pendo (unless it's been enabled as historical metadata). Event properties show the value at the time the event was stored for every event ever. This allows analysis with event properties to show historical values and provide context for how a visitor was using your app when the feature, page, track event, or guide event was recorded.

Custom event properties

Custom event properties are details collected at the time a specific event occurs in your application. There are two subsets of custom event properties: click event properties and Track Event properties.

Before Pendo can capture custom event properties, you must configure these custom values when editing a tagged Feature in the Visual Design Studio or configuring a Track Event.

Custom event properties can vary depending on your specific app and needs, but common examples include cart value, location/region, visitor source, or any other custom value available in your app at the time of a click.

Note: Your subscription can have up to 1,000 unique custom event properties.

You can access all custom event properties through Settings > Event Properties. For more information about click event properties and how to set them up, see Click event properties. For more information about how to configure Track Events, see Configure Track Events.

Event properties in product data

When you view the details of a specific Page, Feature, or Track Event, you can access the event property values that have been recorded for that event.

  1. To view these details, navigate to the Product tab in the left-side menu in Pendo, then select PagesFeatures, or Track Events.

    Product_NavMenu.png

  2. Select a specific Page, Feature, or Track Event from the list.
  3. Locate the Event Breakdown table at the bottom of the page.

    PageDetails_EventBreakdown.png

    The table reflects any applied filters and displays all unique event property values related to the selected Page, Feature, or Track Event and the corresponding user. It also excludes duplicate and null values. Select a Visitor or Account ID from the table to view the corresponding details page.

While the table displays up to 5000 entries, the Download CSV option includes all event properties for further analysis.

Event properties in reports

You can use event properties in Data Explorer and funnels to filter or group your analysis by common values using event property filters and groupings.

Note: If the event property type is time, you can't filter or group by this data. Only string, boolean, and number types are supported.

Filter by event properties

With event property filters, you can filter usage data by established event properties. In both Data Explorer and funnels, the dropdown menu displays up to 400 different values and allows you to search across the full range of property values.

DataExplorer_EventLevelFilters.png

In funnels, you can apply event property filters to individual funnel steps for Features, Pages, and Track Events.

In Data Explorer, there are a few ways to apply event property filters:

  • At the event level on Feature click events, Page load events, and Track Events. Use event property filters on these events when you're looking at or comparing data for specific events. Both global and custom event properties are supported when placing filters on Feature click events and Track Events.
  • Over "Any Activity" events for one or more apps. Use event property filters on these events when trying to understand usage at the app level. Only global event properties are supported when viewing data for "Any Activity".
  • At the report level. Use the Report Filters section to apply event property filters to all events selected in the report, rather than on individual events.

Note: Custom event properties only display on events they're configured for.

Group by event properties

You can group by event properties that return up to 10,000 unique values. The Group By field in both the Data Explorer and funnel query builder includes all global and custom event properties that are boolean or string data types.

Grouping by an event property shows the breakdown of events for the target segment and date range with subtotals for each value. For example, grouping Page views by device type shows how many views were generated on desktop, tablet, mobile devices, and bots.

In the following image, you can see how grouping a Feature click event by operating system in Data Explorer shows the number of clicks generated in each system.

DataExplorer_GroupBy_EventProperty.png

Event properties in segments

You can use event properties when building a segment to increase the specificity of your target segments in analytics. For example, it allows you to create more specific segments that filter for users that have used or haven't used a Feature click, Page view, or Track Event with certain device properties.

The dropdown menu displays up to 400 different values and allows you to search across the full range of property values.

In the following example image, you can see a segment built for all visitors who searched for "always activate" in the Community Search Bar within the last 30 days.

Engage_Segments_ClickEventProperty.png

Note: If the event property type is time, you can't segment with this data; only string, boolean, and number types are supported. You also can't target guides with segments that use event properties. For more information, see Segments.

Event properties and the API

In certain scenarios, you might require more extensive reporting capabilities than what's provided within the Pendo UI. Some common needs include:

  • Utilizing groupings for event properties with numeric or time-based data.
  • Reporting on an event property with more than 10,000 values.
  • Generating reports on multiple event properties simultaneously for a specific click event or Track Event.
  • Needing a comprehensive export of historical data.

In such cases, the solution is to leverage our V1 API, specifically the aggregations endpoint with the source trackEvents or featureEvents. If you don't want to develop the API calls on your own, you can also use third-party tools to pull Pendo data from the API. For additional resources and information, see our API documentation or sign up for our Academy course on Pendo API setup and endpoints.

Was this article helpful?
0 out of 0 found this helpful