Data Governance

Heap's data governance features allow Admins to manage, control, and monitor the core definitions that form your Heap virtual dataset. Definition Verification helps Admins to manage events centrally, and Inactivity Notifications can help prevent 'cruft' from building up in your Heap account.

Inactivity Notifications have been temporarily disabled. For questions, reach out to support@heap.io.

Inactivity Notifications

Inactivity Notifications provide a visual cue when event definitions have failed to collect data for more than 72 hours. This can occur due to site or app changes underneath Heap, or if an Admin or Architect changes an event definition in error.

Inactivity Notifications appear next to an event name in both the Events tab, as well as in-line when building a query.

Inactivity Notifications are currently only supported for event definitions and will not appear for segment or property definitions.

Definition Verification

Definition Verification lets account Admins and Architects ensure that users in your organization are using a trusted and shared set of events in their analysis. Once verified, a green shield icon will appear next to events, symbolizing its trustworthiness, and only users with verification privileges can modify the event.

Definition Verification is currently only supported for event and segment definitions.

Verifying Definitions

As a user with verification permissions (Admins and Architects by default), simply visit any event or segment definition and click on the verification icon in the top-right alongside other definition functions (copy, delete, etc.). You'll be prompted to confirm that you want to verify this definition. By verifying the definition, you are establishing that this definition is confirmed as accurate and can be trusted in reporting throughout your organization.

Once verified, the definition will be confirmed as verified by the green verification shield, the definition metadata will be updated to include when the definition was last verified, and the user who last verified the definition will be listed.

To unverify a definition, simply click the shield again and follow the prompts.

Working With Inactive and Verified Events

When verified, an event or segment definition can only be edited by users with verification permissions (Admins and Architects by default) to ensure that all metrics used in core reporting remain trusted over time. If a user with standard permissions attempts to modify a verified definition, they'll be presented with a message that this definition cannot be modified.

In the Events tab, you can also filter for events that are verified or unverified, or active or inactive:

The verification or inactivity badge will also be presented throughout the Heap interface wherever events or segments are listed to ensure that other users in your organization know what definitions they can trust and use throughout their analysis.

For example, on the Events page, it looks like this:

Verification state presented in definition lists.

Verification state presented in definition lists.

When conducting analysis in the Graph (or any other) module, it looks like this:

Verification state in analysis drop downs.

Verification state in analysis drop downs.

Event and Segment History

When collaborating on a set of event and segment definitions, you can review the history of the event or segment, including who made each change, when the change was made, and what the event definition was at each version.

To access event and segment History, simply navigate to the Define > Events or Segments page, open the event or segment details view, and scroll down to the history section. Here you will see a full record with timestamps for each time the definition was modified.

You can also filter for events or segments that were updated in the last 7 days via the 'Modified' filter.

In the History section, click on any version link to view details about that version. You can also revert to a previous version by clicking on the version you would like to revert to and clicking Restore Version.

When making changes to events or segments, you can also leave a note to provide more context on what the change is and why you made it.

Managing Events, Segments, and Reports

To make it easy for you to clean up and organize your workspace, you can delete or move multiple events, segments, and reports at once. Review the following doc sections for steps to do these:

Got questions? Reach out to support@heap.io and we'll be happy to help!

Data Governance


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.