Emfluence Python API Docs | dltHub

Build a Emfluence-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Emfluence Emailer is an email marketing platform offering REST API endpoints for sending emails, managing contacts, and retrieving reports. The REST API base URL is https://api.emailer.emfluence.com/v1 and All requests require a Bearer access token in the Authorization header..

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 Emfluence data in under 10 minutes.


What data can I load from Emfluence?

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

ResourceEndpointMethodData selectorDescription
contacts_searchcontacts/searchGETrecordsReturns a paginated list of contacts matching search criteria.
emails_lookupemails/lookupGETrecordsRetrieves email details for a given email address.
contacts_getgroupscontacts/getGroupsGETrecordsRetrieves group memberships for a specific contact.
email_reports_domain_summaryemailReports/domainSummaryGETdataProvides domain‑level summary statistics for email reports.
email_reports_overviewemailReports/overviewGETdataReturns overall email report metrics.

How do I authenticate with the Emfluence API?

Authentication uses an access token passed as a Bearer token in the Authorization header.

1. Get your credentials

  1. Log in to the Emfluence Emailer portal.
  2. Navigate to the API/Integration section.
  3. Request an access token from support or generate one if the portal provides a generate button.
  4. Copy the token and store it securely for use in the Authorization header.
  5. Verify the token works by making a test call via the API console.

2. Add them to .dlt/secrets.toml

[sources.emfluence_source] access_token = "your_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:

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

1. Install the dlt AI Workbench:

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:

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 Emfluence 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:

python emfluence_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline emfluence_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 emails_lookup and contacts_getgroups from the Emfluence API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def emfluence_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.emailer.emfluence.com/v1", "auth": { "type": "bearer", "token": access_token, }, }, "resources": [ {"name": "emails_lookup", "endpoint": {"path": "emails/lookup", "data_selector": "records"}}, {"name": "contacts_getgroups", "endpoint": {"path": "contacts/getGroups", "data_selector": "records"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="emfluence_pipeline", destination="duckdb", dataset_name="emfluence_data", ) load_info = pipeline.run(emfluence_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):

import dlt data = dlt.pipeline("emfluence_pipeline").dataset() sessions_df = data.emails_lookup.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM emfluence_data.emails_lookup LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("emfluence_pipeline").dataset() data.emails_lookup.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 Emfluence data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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


Troubleshooting

Authentication Errors

  • 200 Invalid access token – The token supplied in the Authorization header is missing, malformed, or expired. Obtain a new token via the support process and retry.

Rate Limiting / Connection Limits

  • 5 Too many concurrent connections – Exceeds the allowed number of simultaneous connections. Reduce parallelism or introduce retries with back‑off.
  • 403 Connection limits – Reached the account's connection quota. Contact Emfluence support to increase limits or throttle request volume.

General API Errors

  • Errors are returned with success = 0 and an errors array containing details. Inspect the code field to determine the specific issue.

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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Emfluence?

Request dlt skills, commands, AGENT.md files, and AI-native context.