---
updatedAt: 2026-04-01T20:49:59.000Z
agentTools:
  projectIndex: https://developers.heap.io/llms.txt
---

# API Reference Overview

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?

Heap is a digital insights platform that helps you understand how and why customers engage with your digital experience by automatically capturing a wealth of data about user interactions with your site or app. For more details, see [What is Heap?](https://help.heap.io/getting-started/how-heap-works/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](https://developers.heap.io/docs).

## 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](https://help.heap.io/category/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](https://help.heap.io/getting-started/how-heap-works/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](https://help.heap.io/getting-started/how-heap-works/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](https://help.heap.io/getting-started/setting-up-heap/enrich-your-dataset-via-apis/) page of the Setting Up Heap guide.

## Changelogs

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

* [iOS Changelog](https://developers.heap.io/docs/ios-changelog)
* [Android Changelog](https://developers.heap.io/docs/android-changelog)
* [React Native Changelog](https://developers.heap.io/docs/react-changelog)
* [heap.js Changelog](https://developers.heap.io/docs/heapjs-changelog)

## Need Help?

<Anchor label="Contact support" target="_blank" href="https://heapanalytics.com/app/contact">Contact support</Anchor> if you need further help!

<HTMLBlock>{`
<div id="heapCustom">
  <strong>Did you find what you were looking for?</strong>
  <br>
  <a href="https://survey.nicereply.com/heap.api/docs/API-Reference-Overview?s=10">
  <img alt="Thumb up" src="https://survey.nicereply.com/trackmaili/thumb_10.png">
  </a>
  <a href="https://survey.nicereply.com/heap.api/docs/API-Reference-Overview?s=1">
    <img alt="Thumb down" src="https://survey.nicereply.com/trackmaili/thumb_1.png">
  </a>
</div>
`}</HTMLBlock>