Heap

This documentation for the Heap integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Heap, visit our connection instructions.

Version

This integration utilizes the Heap User Deletion (Delete API).

Base URL

The base URL used for all Heap API endpoints:

https://heapanalytics.com/api/public/v0

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
POST	/auth_token	Get and refresh access token

---

Authentication & Authorization

The DataGrail Heap integration connects using API key authentication which requires an App ID and API key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Heap API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Limits

Limits in Heap are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Deletion

DataGrail's Heap integration provides Asynchronous (Whole Record) Deletion capabilities for the following supported identifier category: Any.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Submit deletion request using configured identifiers.
2. Continuously check the deletion status until it is completed by Heap.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/deletion_status/deletion_request_id	Fetch the status of the user deletions
POST	/user_deletion	Submit deletion request

---