Welcome to Heap’s API documentation. Our APIs allow developers to capture additional data about user interactions outside of what Heap autocaptures out-of-the-box, manage identity across sessions and devices, and more.

What is Heap?

If you haven’t used Heap before, in summary, Heap is a product analytics platform that helps you understand how and why customers engage with your product by automatically capturing a wealth of data about user interactions with your site or app. For more details, see What is Heap?

Installation

If you’re looking to install Heap for the first time, see the installation guides for web, mobile, react native, and third-party platforms listed in our developer guides.

Integrations

Post-install, you can set up integrations with Heap to capture data from external sources like your CRM tool, email marketing tool, and more, without needing to use our APIs. See Integrations for a full list of what’s available and steps to set up each one.

Data Capture

Once installed, Heap automatically captures a wealth of client-side interactions out-of-the-box, including clicks, pageviews, form submissions, and change events, with no developer work needed. For a review of everything Heap autocaptures without any customization, see Autocaptured Data.

To capture additional user interactions, you can use several of the APIs listed below. For a comparison of benefits and drawbacks to capturing data either client or server-side, see Tracking Web Custom Events Client-side vs. Server-side.

API Use Cases

You can use the APIs listed below to collect custom data, manage user identity, and adhere to data privacy guidelines. A list of APIs we recommend setting up along with use cases is available in the Enrich Your Dataset Via APIs page of the Setting Up Heap guide.

Changelogs

See what's new and notable changes to Heap’s SDKs:

Need Help?

Feel free to drop us a line at [email protected] with any questions!

Did you find what you were looking for?
Thumb up Thumb down