Source
Data access, export & self-hosting — found from sitemap — Heap
Checked for Heap on 10 Nov 2026
- Page
- https://developers.heap.io/docs/api-reference
- Checked
- 10 Nov 2026, 18:12 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:937857c18c61d90862c3e974a6c3f27fc0cea487ccc08543eb3b0c94dd3490f7
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Track custom events Report an error
“Use this API to send custom events and associated metadata to Heap that we do not automatically capture, such as purchase information, email sent, and more.”
-
Track event name limit Report an error
“(required) event name: name of the custom interaction. Limited to 255 characters.”
-
Track property limits Report an error
“(optional) event properties: a JSON object key-value pairs to be associated with an event. Keys must be a string fewer than 512 characters and values must be an array, boolean, number or string fewer than 1024 characters.”
-
Identify Report an error
“Use this API to attach a unique identity and maintain user histories across sessions, devices, and browsers under a single profile in Heap.”
-
Identify limit Report an error
“(required) identity: a string or number that uniquely identifies a user, such as an email, handle, or username. This means no two users in one environment may share the same identity. Must be fewer than 255 characters.”
-
Get identity Report an error
“Use this API to retrieve the current user’s identity, if identified. Use identity to link activity between Heap’s client-side and server-side track APIs.”
-
Reset identity Report an error
“Use this API to reset a user’s identity to an anonymous state after they have logged out.”
-
Add event properties Report an error
“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.”
-
Remove event property Report an error
“Use this API to stop a single event property from getting attached to all subsequent events.”
-
Clear event properties Report an error
“Use this API to remove all previously stored event properties from the cookie”
-
Add user properties Report an error
“Use this API to attach custom properties at the user level, such as user-level info from your database or demographic info.”
-
User property limits Report an error
“(required) user properties: a JSON object containing key-value pairs to be associated with a user. Keys must be a string fewer than 512 characters and values must be a boolean, number or string fewer than 1024 characters.”
-
Track pageview Report an error
“Use this API to send a new pageview and associated metadata. This api is typically used with the disablePageviewAutocapture configuration.”
-
Add pageview properties Report an error
“Use this API to attach custom properties at a pageview level.”
-
Pageview properties auto clear Report an error
“It's important to note that pageview properties are automatically cleared upon page refresh or load.”
-
On ready Report an error
“Use this API to define a function that executes once Heap is fully initialized and operational.”
-
Get session ID Report an error
“Use this API to retrieve the session ID. This API can be used to tie Heap session data to data from external sources.”
-
Get pageview metadata Report an error
“Use this API to retrieve the current pageview information.”
-
Get user ID Report an error
“Use this API to retrieve the current user’s ID.”
-
Set log level Report an error
“Use this API to adjust the logging level of Heap on the client-side.”
-
Custom APIs purpose Report an error
“Bring in additional data that Heap does not autocapture, including custom events and properties”
-
Server side track linking Report an error
“Use identity to link activity between Heap’s client-side and server-side track APIs.”
Scores citing this record
- The Agency Developer Goals, events, funnels & e-commerce
- The Agency Developer Consent-free operation & data minimisation
- The Agency Developer Data access, export & self-hosting
- The Data Protection Officer Traffic, sources & campaign reports
- The Data Protection Officer Goals, events, funnels & e-commerce
- The Data Protection Officer Consent-free operation & data minimisation
- The Data Protection Officer Data access, export & self-hosting
- The E-Commerce Marketing Lead Goals, events, funnels & e-commerce
- The E-Commerce Marketing Lead Consent-free operation & data minimisation
- The E-Commerce Marketing Lead Data access, export & self-hosting
- The Growth Analyst Goals, events, funnels & e-commerce
- The Growth Analyst Consent-free operation & data minimisation
- The Growth Analyst Data access, export & self-hosting
- The Growth Analyst Installation, integrations & performance
- The Public-Sector Site Owner Traffic, sources & campaign reports
- The Public-Sector Site Owner Goals, events, funnels & e-commerce
- The Public-Sector Site Owner Consent-free operation & data minimisation
- The Public-Sector Site Owner Data access, export & self-hosting
- The Public-Sector Site Owner Installation, integrations & performance
- The Skeptic Goals, events, funnels & e-commerce
- The Skeptic Consent-free operation & data minimisation
- The Skeptic Data access, export & self-hosting
- The Skeptic Installation, integrations & performance
- The Skeptic Pricing transparency