Heap

Fuel product growth and team agility. Heap automatically captures web and mobile app behavioral data. Retroactively analyze behavioral data without writing code.

Go to site

Heap API Integrations

Build and run workflows using the Heap API. Use 1000s of source-available triggers and actions across 1000+ apps. Or write custom code to integrate any app or API in seconds.

Overview

Heap is an analytics tool that allows developers to track user engagement and conversions within their web or mobile app. Heap provides an API that developers can use to build custom integrations, dashboards, and reports.

Some examples of what you can build using the Heap API include:

  • A dashboard to track app usage and engagement metrics
  • A report to track conversion rates and revenue
  • A custom integration to track user behavior in your app
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    heap: {
      type: "app",
      app: "heap",
    }
  },
  async run({steps, $}) {
    // From the docs: https://docs.heap.io/reference#track-1
    // "Requests are limited to 30 requests per 30 seconds per identity per app_id"
    return await axios($, {
      method: "POST",
      url: `https://heapanalytics.com/api/track`,
      headers: {
        "Content-Type": "application/json",
      },
      data: {
        app_id: this.heap.$auth.app_id,
        identity: params.identity,
        event: params.event,
        timestamp: params.timestamp || (new Date()).toISOString(),
        properties: params.properties,
      }
    })
  },
})

Authentication

Heap uses API keys for authentication. When you connect your Heap account, Pipedream securely stores the keys so you can easily authenticate to Heap APIs in both code and no-code steps.

Your Heap app ID is the number given to you by Heap when you first installed the app, found in your tracking code.