Heap Python API Docs | dltHub

Heap is a digital insights platform that automatically captures user interactions and provides APIs to send custom events, manage user identity, and integrate external data. The REST API base URL is https://api.heap.io and Heap APIs use OAuth2 token authentication for server‑side endpoints..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Heap data in under 10 minutes.

---

What data can I load from Heap?

Here are some of the endpoints you can load from Heap:

---

How do I authenticate with the Heap API?

Authentication is performed via OAuth2 bearer tokens; include an Authorization: Bearer header on requests.

1. Get your credentials

1. Log in to the Heap dashboard.
2. Navigate to Integrations → API Access.
3. Click Create new OAuth application.
4. Record the generated Client ID and Client Secret.
5. Use the token endpoint (e.g., https://api.heap.io/oauth/token) with your client credentials to obtain an access token.

2. Add them to .dlt/secrets.toml

Copy
[sources.heap_source]
access_token = "your_oauth_access_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Heap API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python heap_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline heap_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset heap_data
The duckdb destination used duckdb:/heap.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline heap_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads track and identify from the Heap API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def heap_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.heap.io",
            "auth": {
                "type": "bearer",
                "token": access_token,
            },
        },
        "resources": [
            {"name": "track", "endpoint": {"path": "track"}},
            {"name": "identify", "endpoint": {"path": "identify"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="heap_pipeline",
        destination="duckdb",
        dataset_name="heap_data",
    )
    load_info = pipeline.run(heap_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("heap_pipeline").dataset()
sessions_df = data.track.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM heap_data.track LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("heap_pipeline").dataset()
data.track.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Heap data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication Errors

• 401 Unauthorized – Occurs when the OAuth2 token is missing, expired, or invalid. Refresh the token using the token endpoint.

Rate Limiting

• 429 Too Many Requests – Heap enforces rate limits per project. Back‑off and retry after the Retry-After header.

Request Validation

• 400 Bad Request – Returned when required fields are missing or malformed JSON is sent. Verify the request payload matches the API specification.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack