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.0
  • v1.0stable
    (Custom API)
HomeDeveloper GuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
    Developer GuidesAPI Reference
discard

Getting Started

  • Developer Guides Overview

Standard Installations

  • Web Installation
  • iOS Installation
  • Android Installation

React Native

  • React Native Installation
  • Migrating legacy React Native events for Heap 0.9.0

3rd Party Installations

  • Electron Installation
  • Google Tag Manager Installation
  • Hybrid Mobile Apps Installation
  • Instapage Installation
  • Kony 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

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

Changelogs

  • iOS Changelog
  • Android Changelog
  • React Native Changelog
  • heap.js Changelog

Getting Started

  • Developer Guides Overview

Standard Installations

  • Web Installation
  • iOS Installation
  • Android Installation

React Native

  • React Native Installation
  • Migrating legacy React Native events for Heap 0.9.0

3rd Party Installations

  • Electron Installation
  • Google Tag Manager Installation
  • Hybrid Mobile Apps Installation
  • Instapage Installation
  • Kony 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

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

Changelogs

  • iOS Changelog
  • Android Changelog
  • React Native Changelog
  • heap.js Changelog

Overview

  • API Reference Overview

Client-Side API

  • Client-side APIs Overview
  • track
  • identify
  • addUserProperties
  • resetIdentity
  • addEventProperties
  • removeEventProperty
  • clearEventProperties
  • userID
  • identity
  • setAppId
  • init
  • changeInterval (iOS)
  • startEVPairing (iOS & Android)
  • stopEVPairing (iOS & Android)
  • Disable Mobile Visualizer Pairing Gesture (iOS & Android)

Server-Side API

  • Server-side APIs Overview
  • post
    Track
  • Bulk Track
  • post
    Add User Properties
  • Bulk Add User Properties
  • post
    Add Account Properties
  • User Deletion