Back
TLDR
The Heap API allows developers to capture additional user interaction data, manage user identity across sessions and devices, and integrate with external tools. It focuses on enriching the dataset beyond Heap's automatic data capture capabilities.
Capabilities
Client Side Event TrackingCapture custom user interaction data directly from web browsers. Supports: track, identify, resetIdentity, addUserProperties, addEventProperties, removeEventProperty, clearEventProperties, userID, identity, setAppId, sessionId, init.
Mobile Client Side Event TrackingCapture custom user interaction data from iOS and Android mobile applications. Supports: stopEVPairing, disableDefaultPairingGesture, startEVPairing, changeInterval.
Server Side Event TrackingSend custom event data to Heap from your backend servers. Supports: Track, Bulk Track.
User Identity ManagementManage and associate user identities across different sessions and devices. Supports: identify, Identify post.
User Properties ManagementAdd and update properties for individual users. Supports: addUserProperties, Add User Properties post, Bulk Add User Properties.
Account Properties ManagementAdd and update properties for accounts (groups of users). Supports: Add Account Properties post, Bulk Add Account Properties.
Data Privacy & User DeletionManage user data in compliance with privacy regulations, including user deletion. Supports: User Deletion (Delete API).
IntegrationsConnect Heap with external tools like CRM and email marketing platforms to enrich data without direct API calls.