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:

  • Source: 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.
  • Visible: You can control which event properties are visible on the Insights page. Clear the checkbox 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. Only the first five events are listed; click Show N more to open a searchable list of every event carrying the property. Clicking an event, either in the column or in that list, narrows the page to the properties of that single event. The column is hidden once a single event is selected, since every row would then repeat that same event.

You can filter the table using the free text search input or by selecting an event in the All events dropdown. Both filter the list as you type or select, without reloading the page. Click Reset filters next to the dropdown to clear them all at once. Clicking the column headers sorts the list, and every property is listed on one page.

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. Click the Show values button at the end of a property's row.

The stored values belong to one property of one event, so the button is only active when the property resolves to a single event: either the property was discovered on exactly one event, or you selected an event in the All events filter. Otherwise the button is greyed out and its tooltip asks you to select a single event first.

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.