Reach out with questions, bugs, or suggestions. We'll respond ASAP. Your message is sent! We'll respond via email shortly.

Data Format

Heap's power comes from automatically capturing all the user interactions that happen in your app. This data is sanitized and organized into the following hierarchy for you, where users have many sessions and sessions have many events:

Heap Data Hierarchy

Properties of each object are as follows. Note that exported data has a different format, as described here.


For web, a user maps directly to a unique client-side cookie. For iOS, a user maps to a shared NSUserDefaults object. It contains the following properties:


For web, a session ends after 30 minutes of inactivity from the user. For iOS, a session ends after your app has entered the background. It contains the following properties:


All the raw client-side actions users performed in your app. It contains the following properties:

Hiding Elements from Heap

If there's a sensitive element you don't want auto-tracked, you can hide it from Heap by just adding the attribute heap-ignore. All descendent elements will also be ignored by Heap.

No events triggered on the element <input type='text' heap-ignore='true'>, for instance, will be captured by Heap.

Additionally for iOS, you can use defined runtime attributes to set heapIgnore to a boolean and make sure it's enabled.