For AI agents: visit https://developers.heap.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
HeapHeap
Developer GuidesAPI Reference
Custom API

Developer GuidesAPI ReferenceHelp CenterEngineering BlogCommunityOpen AppHeap
API Reference
Developer GuidesAPI ReferenceHelp CenterEngineering BlogCommunityOpen App
Custom API

Overview

  • API Reference Overview

Client-Side API

  • Client-side APIs Overview
  • track
  • identify
  • resetIdentity
  • addUserProperties
  • addEventProperties
  • removeEventProperty
  • clearEventProperties
  • userID
  • identity
  • setAppId
  • sessionId
  • init

Client-side API (Mobile)

  • stopEVPairing (iOS & Android)
  • Disable Mobile Visualizer Pairing Gesture (iOS & Android)
  • startEVPairing (iOS & Android)
  • changeInterval (iOS)

Server-Side API

  • Server-side APIs Overview
  • Trackpost
  • Bulk Track
  • Identifypost
  • Add User Propertiespost
  • Bulk Add User Properties
  • Add Account Propertiespost
  • Bulk Add Account Properties
  • User Deletion (Delete API)

Authentication

Set up the welcome page for your API to help users make their first call.

Log in to see your API keys
API KeyLabelLast Used
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!