Heap

Developer Guides
API Reference
Help Center
Engineering Blog

Open App

Heap Developer Portal

Welcome to the Heap Developer Portal. Review our guides, API docs, and changelogs to make the most of your Heap implementation.

v1.0stable
(Custom API)

HomeDeveloper GuidesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Developer Guides

Getting Started

Overview

Standard Installations

Web Installation
iOS Installation
Android Installation

3rd Party Installations

Electron Installation
Google Tag Manager Installation
Hybrid Mobile Apps Installation
Instapage Installation
Kony Installation
React Native Installation
Segment Installation
Shogun Installation
Shopify Installation
Squarespace Installation
Wix Installation
Wordpress Installation
Unbounce Installation

Managing Identity

Using Identify
User Properties for A/B Testing

Managing Sessions

Sessionization
Backgrounded Mobile Events

Custom Tracking

Executing JavaScript using Snapshots

Custom Event Tracking

Tracking Purchases
Tracking Video Plays
Tracking Hover Events
Tracking Field Validation Errors

Custom Tracking on Pageviews

Installing Heap in an iFrame
Tracking Impressions
Tracking Page Load Time
Tracking AMP or FBIA Pages

Using Heap with a Minified DOM

Impact of DOM Minification on Heap Usage
General Strategies for Using Heap with Minified DOMs
Using React with Heap

Changelogs

iOS Changelog
Android Changelog
React Native Changelog
heap.js Changelog

Getting Started

Overview

Standard Installations

Web Installation
iOS Installation
Android Installation

3rd Party Installations

Electron Installation
Google Tag Manager Installation
Hybrid Mobile Apps Installation
Instapage Installation
Kony Installation
React Native Installation
Segment Installation
Shogun Installation
Shopify Installation
Squarespace Installation
Wix Installation
Wordpress Installation
Unbounce Installation

Managing Identity

Using Identify
User Properties for A/B Testing

Managing Sessions

Sessionization
Backgrounded Mobile Events

Custom Tracking

Executing JavaScript using Snapshots

Custom Event Tracking

Tracking Purchases
Tracking Video Plays
Tracking Hover Events
Tracking Field Validation Errors

Custom Tracking on Pageviews

Installing Heap in an iFrame
Tracking Impressions
Tracking Page Load Time
Tracking AMP or FBIA Pages

Using Heap with a Minified DOM

Impact of DOM Minification on Heap Usage
General Strategies for Using Heap with Minified DOMs
Using React with Heap

Changelogs

iOS Changelog
Android Changelog
React Native Changelog
heap.js Changelog

Client-Side API

track
identify
resetIdentity
addUserProperties
addEventProperties
removeEventProperty
clearEventProperties
userID and Identity
changeInterval
setAppId
init
startEVPairing
stopEVPairing
Disable Mobile Visualizer Pairing Gesture

Server-Side API

post
Track
post
Add User Properties
post
Bulk Track
post
Bulk Add User Properties
post
Add Account Properties
User Deletion

Wix Installation

Wix allows third-party JavaScript via Google Tag Manager. Please see Wix instructions for Google Tag Manager to install Heap on your Wix site.

Updated 2 months ago

Wix Installation

Suggested Edits are limited on API Reference Pages

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