Skip to content
J·BJon BishopFractional growth marketer

Data platforms · llms.txt file breakdown

Heap llms.txt

A directly retrieved Markdown index for Heap's documentation, with 71 links across 11 detected headings.

The actual file

Source Markdown

The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.

Open saved text ↗

Complete saved Markdown shown below.

# Heap Documentation

> Heap's APIs allow developers to capture additional data about user interactions, manage identity across sessions and devices, and more.

## Developer Guides: Getting Started
- [Overview](https://developers.heap.io/docs/overview.md)
- Web installation
  - [Installation](https://developers.heap.io/docs/web.md)
  - [API Reference (heap.js 5)](https://developers.heap.io/docs/api-reference.md)
  - [Ignoring Sensitive Data and PII](https://developers.heap.io/docs/ignoring-sensitive-data-and-pii.md)
  - [Shadow DOM](https://developers.heap.io/docs/shadowdom.md)
  - [Plugin Framework](https://developers.heap.io/docs/plugin-framework.md)
    - [Plugin Framework - Heap Event Message Schema](https://developers.heap.io/docs/plugin-framework-heap-event-schema.md)
  - [Web SDK upgrade FAQ](https://developers.heap.io/docs/frequently-asked-questions.md)
- Mobile installation
  - [iOS quick start](https://developers.heap.io/docs/ios.md)
  - [Swift Ecosystem quick start](https://developers.heap.io/docs/swift-ecosystem-quick-start.md)
  - [Android quick start](https://developers.heap.io/docs/android.md)
  - [Android Ecosystem quick start](https://developers.heap.io/docs/android-ecosystem-quick-start.md)
  - [React Native quick start](https://developers.heap.io/docs/react-native-quick-start.md)
  - [Flutter quick start](https://developers.heap.io/docs/flutter-quick-start.md)
  - [Capacitor Bridge quick start](https://developers.heap.io/docs/capacitor-bridge-installation.md)
  - [Xamarin/Maui quick start](https://developers.heap.io/docs/xamarin-quick-start.md)
  - [Hybrid Mobile Apps Installation](https://developers.heap.io/docs/hybrid-mobile-apps.md)
- Third party integrations
  - [Google Tag Manager (GTM) Installation](https://developers.heap.io/docs/google-tag-manager.md)
  - [Electron Installation](https://developers.heap.io/docs/electron.md)
  - [Instapage Installation](https://developers.heap.io/docs/instapage.md)
  - [Squarespace Installation](https://developers.heap.io/docs/squarespace.md)
  - [Tumblr Installation](https://developers.heap.io/docs/tumblr-installation.md)
  - [Unbounce Installation](https://developers.heap.io/docs/unbounce.md)
  - [Wordpress Installation](https://developers.heap.io/docs/wordpress.md)

## Developer Guides: Web Tracking Guides
- [Track user identity](https://developers.heap.io/docs/using-identify.md)

## Developer Guides: Mobile Tracking guides
- [Manually track events](https://developers.heap.io/docs/manual-event-tracking.md)
- [Hide sensitive data](https://developers.heap.io/docs/hide-sensitive-data.md)
- [Tracking notification interactions](https://developers.heap.io/docs/tracking-notification-interactions.md)
- [Continuing mobile sessions in WebViews](https://developers.heap.io/docs/continuing-mobile-sessions-in-webviews.md)
- Connecting Heap and Contentsquare
  - [Session Replay for apps with Heap analytics](https://developers.heap.io/docs/syncing-heap-data-to-contentsquare.md)
  - [Heap analytics for apps with Contentsquare](https://developers.heap.io/docs/syncing-contentsquare-data-to-heap.md)

## Developer Guides: SDK Reference
- [Android SDK Reference](https://developers.heap.io/docs/android-sdk-reference.md)
- [Swift SDK reference](https://developers.heap.io/docs/swift-and-uikit-sdk-reference.md)
- [React Native SDK Reference](https://developers.heap.io/docs/react-native-sdk-reference.md)
- [Flutter SDK Reference](https://developers.heap.io/docs/flutter-sdk-reference.md)
- Classic SDKs
  - [iOS Classic Installation](https://developers.heap.io/docs/ios-legacy.md)
  - [Android Classic Installation](https://developers.heap.io/docs/android-legacy.md)
  - [React Native Classic Installation](https://developers.heap.io/docs/react-legacy.md)
  - Web Classic Installation
    - [Install Heap.js](https://developers.heap.io/docs/install-heapjs.md)
    - [Track impressions](https://developers.heap.io/docs/tracking-impressions.md)
    - [Track in an iFrame](https://developers.heap.io/docs/installing-heap-in-an-iframe.md)
    - [Track AMP or FBIA pages](https://developers.heap.io/docs/track-amp-or-fbia-pages.md)

## Developer Guides: Mobile Custom Configuration
- [Android Custom Configuration](https://developers.heap.io/docs/android-custom-configuration.md)
- [Swift Custom Configuration](https://developers.heap.io/docs/swift-custom-configuration.md)
- [React Native Custom Configuration](https://developers.heap.io/docs/react-native-custom-configuration.md)
- [Flutter Custom Configuration](https://developers.heap.io/docs/flutter-custom-configuration.md)

## Developer Guides: Changelogs
- [heap.js 5 Changelog](https://developers.heap.io/docs/heapjs-5-changelog.md)
- [Android Changelog](https://developers.heap.io/docs/android-changelog.md)
- [Swift iOS Changelog](https://developers.heap.io/docs/ios-changelog.md)
- [React Native Changelog](https://developers.heap.io/docs/react-changelog.md)
- [Flutter Changelog](https://developers.heap.io/docs/flutter-changelog.md)
- [Heap Gradle Plugin Changelog](https://developers.heap.io/docs/heap-gradle-plugin-changelog.md)
- [Classic heap.js Changelog](https://developers.heap.io/docs/heapjs-changelog.md)

## API Reference: Overview
- [API Reference Overview](https://developers.heap.io/reference/api-reference-overview.md)

## API Reference: Client-Side API
- [track](https://developers.heap.io/reference/track.md): 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.
- [identify](https://developers.heap.io/reference/identify.md): This API allows you to attach a unique identity and maintain user histories across sessions, devices, and browsers under a single profile in Heap.
- [addUserProperties](https://developers.heap.io/reference/adduserproperties.md): This API allows you to attach custom properties at the user level, such as user-level info from your database or demographic info.   Note that these properties are stateless, and only the most recent…
- [addEventProperties](https://developers.heap.io/reference/addeventproperties.md): 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.
- [userID](https://developers.heap.io/reference/userid-and-identity.md): Retrieve the current user’s ID. This API is read-only and is primarily used to [QA events With Live data feed](https://help.heap.io/define-analyze/data-management/qa-events-with-live-view/).
- [identity](https://developers.heap.io/reference/identity.md): The current user’s identity, if identified. Use identity to link activity between Heap’s client-side and server-side track APIs.

## API Reference: Server-Side API
- [Server-side APIs Overview](https://developers.heap.io/reference/server-side-apis-overview.md)
- [Track](https://developers.heap.io/reference/track-1.md): Use this API to send custom events to Heap server-side. We recommend using this for events that need to exactly match your backend, such as completed order transaction info, or events that are not…
- [Bulk Track](https://developers.heap.io/reference/bulk-track.md): If you have many custom track events to send at once, you can use this API.
- [Identify](https://developers.heap.io/reference/identify-1.md): This API allows you to identify users given some anonymous user_id from the Heap SDK and some known identity, such as an email address.  When this call is made, all events associated with the…
- [Add User Properties](https://developers.heap.io/reference/add-user-properties.md): This API allows you to attach custom properties to any identified users from your servers, such as Sign Up Date (in [ISO8601…
- [Bulk Add User Properties](https://developers.heap.io/reference/bulk-add-user-properties.md): If you have many custom user properties to attach all at once, you can use this API.
- [Add Account Properties](https://developers.heap.io/reference/add-account-properties.md): This API allows you to attach custom account properties to users. An account ID or use of our Salesforce integration is required for this to work. Note that, as your set of accounts and their…
- [Bulk Add Account Properties](https://developers.heap.io/reference/bulk-add-account-properties.md): If you have many custom account properties to attach all at once, you can use this API.
- [User Deletion (Delete API)](https://developers.heap.io/reference/user-deletion.md): Use this API to delete users from your Heap workspace. This API requires an auth token, which you can generate.

## Pages
- [404](https://developers.heap.io/page/404.md)

Measured from the saved file

Linked document

UTF-8 text size
8.4 KB8651 bytes
Token count
1917o200k_base encoding
Markdown links
7171 distinct URLs
Fenced code blocks
099 lines in the file

Size measures the captured UTF-8 text, not compressed transfer size. Tokens are counted with a named tokenizer; other models can count differently. Neither measure establishes context compatibility or answer quality.

Project H1
Heap Documentation

Opening blockquote

Heap's APIs allow developers to capture additional data about user interactions, manage identity across sessions and devices, and more.

Context architecture

How the content is divided

10 H2 sections organize 71 parsed Markdown links. 70 links point to .md or .markdown paths; 1 link occurrences use another hostname. Linked destinations have not been recursively validated.

H2 sectionLinksUTF-8 bytesTokens
Developer Guides: Getting StartedLine 5242069492
Developer Guides: Web Tracking GuidesLine 3417618
Developer Guides: Mobile Tracking guidesLine 376670149
Developer Guides: SDK ReferenceLine 4611992230
Developer Guides: Mobile Custom ConfigurationLine 61439975
Developer Guides: ChangelogsLine 677566141
API Reference: OverviewLine 7619218
API Reference: Client-Side APILine 7971402290
API Reference: Server-Side APILine 8791834389
PagesLine 9814814

Link counts exclude parsed fenced and inline code and resolve relative destinations against the final endpoint. Section sizes cover the text below each H2 until the next H2.

Embedded material

Code, installation and API examples

Fenced blocks
0 closed
Declared languages
No fenced blocks detected
Package-install commands
0 detected in fenced or inline code
Authentication examples
0 fenced lines match API-key, Authorization, Bearer, OAuth or access-token patterns
HTTP request examples
0 fenced lines match request-method patterns
Authentication links
0 links have authentication-related labels

Embedded example text and links to further documentation are counted separately. A code block does not establish that a sample runs or that an authentication flow succeeds.

Publisher prioritization

The Optional section

No H2 section named “Optional” was detected in this file.

The community proposal uses Optional by convention for secondary links that can be skipped for a shorter context. This label does not establish that everything outside it is critical, or that the material inside it is deprecated.

Machine-readable routes

MCP references and configuration text

No MCP or Model Context Protocol term was detected in the captured file. 0 links have MCP-related labels or paths. 0 fenced lines match mcpServers, mcp_servers or an mcp add command.

These are text and link observations. No MCP server connection, authentication or tool call was tested.

Index and bundle

llms-full.txt companion

Not found at checked URLs

A verified text response establishes a companion at the checked URL. It does not prove the bundle contains all product documentation, that generation is automated, or that it fits an assistant’s context window.

Change evidence

What can be said about freshness

This capture establishes a baseline. Update frequency cannot be determined from one observation.

Linked release and migration material

7 links have release, changelog, deprecation or migration terms in their labels or paths. These provide places to investigate product changes separately.

File changes can reveal documentation edits or navigation changes. They do not by themselves measure product release velocity, accuracy, agent adoption or AI visibility.

Capture identity and measurement method
Requested endpoint
https://developers.heap.io/llms.txt
Final endpoint
https://developers.heap.io/llms.txt
HTTP status
200
Content type
text/plain; charset=utf-8
Text retrieval
Firecrawl literal text capture
Tokenizer
tiktoken 0.14.0 · o200k_base
SHA-256 of saved UTF-8 text
a49d838013eb9747267e1ef31cedf7c6c481b189aa0e766efd5bcb5b5a35cb79

Counts use a deterministic parser, not a spec-compliance grade. Unusual Markdown and indented code can fall outside its recognized patterns. See the llms.txt proposal and tokenizer implementation.

Related tools and resources

Contact Jon