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

Developer Guides API Reference

Custom API

Developer Guides API Reference Help Center Engineering Blog Community Open App

API Reference

Developer Guides API Reference Help Center Engineering Blog Community Open 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)

addEventProperties

Use this API to send stateful information into Heap as a set of global key-value pairs that get attached to all of a user's subsequent events.

Updated about 2 months ago

addUserProperties

removeEventProperty

Updated about 2 months ago

addUserProperties

removeEventProperty

- Arguments