Skip to main content

Event Property Catalog

The event property catalog helps you track and document the properties of all events in your data warehouse.

Event properties are added and removed automatically when you add or remove an event table. You cannot create or remove them manually.

image

Use cases​

Maintaining the display name and description fields of the event property records can help you:

  • map technical abbreviations and raw property names to human-readable labels
  • explain the meaning of an event property with a description

All features​

Listing event properties in the catalog​

The Event Properties tab on the catalog page lists the event properties stored in the catalog of the selected workspace.

All event properties are listed only once, even if multiple events have properties with the same name.

The table contains the following columns:

  • Property name: This is the column name of the event data table. The column name uses the <column name>.<field key> format if the event property is a nested data structure (e.g., struct, JSON).
  • Display name: The display name used to reference the event property on the Insights page and in charts, dashboards, and tooltips.
  • Description: The description can help you find a suitable event when browsing the Insights page.
  • Visibility: You can control which event properties are visible on the Insights page. Select the value Hidden for a property and you won't see it listed in any dropdowns. Insights that already use this field won't break, but they cannot be recreated.
  • Events: Shows which events have this property. Click an event link to navigate to the Event catalog page with a predefined filter for the selected event. Only the first five events are listed.

You can filter the table using the free text search input or by selecting an event from the dropdown. If you use the free text search, the list updates with the most recent results as you type your search expression. Click the Reset filters button next to the search bar to clear all filters.

Only 20 event properties are shown per page. To see the remaining properties, narrow the results with a search expression or browse the other pages in the pagination bar. The results are sorted in alphabetical order by the property name column.

Updating display name, description​

To change the display name or description of an event property catalog record, click the input field and enter the desired value. The catalog is updated once you stop typing.

Refreshing filter values and changing property data types​

You can also refresh the filter values in the Event Properties tab. Simply choose an event and click the "Manage values" button for any of its properties.

image

Here, you can refresh the possible filter values. You can also change the data type of any property.

warning

Changing the data type may cause the generated SQL queries to stop working. Proceed only if you are sure the data type change is necessary.