Heap

Heap automatically captures user interactions so you can analyze reader behavior without manual event tracking. Enable the integration to connect your documentation site to Heap.

Prerequisites

• A Heap account with a project created

• Your Heap app ID

• Publishing access to your documentation project

Configure from the Editor

Configure via documentation.json

Add the heap key under integrations in your documentation.json:

{
  "integrations": {
    "heap": {
      "appId": "your_app_id"
    }
  }
}

Where to find your app ID

1. Sign in to Heap.

2. Go to Account → Manage → Projects.

3. Copy the app ID for your project.

What's next

• Analytics and Chat Integrations — overview of all supported integrations

• Amplitude — event-based analytics with Amplitude

• Analytics overview — view traffic and engagement data for your documentation