Load Revive Adserver data in Python using dltHub

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

Last updated:

Revive Adserver REST API provides remote communication to the Revive Adserver platform using a RESTful architecture. The REST API base URL is http://<host-name>/adserver/www/api/v2/rest and all requests require a Basic Authentication 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 add "dlt[hub]" and start loading Revive Adserver data in under 10 minutes.


What data can I load from Revive Adserver?

Here are some of the endpoints you can load from Revive Adserver:

ResourceEndpointMethodData selectorDescription
agencies/agc/lstGETList agencies with optional sort/limit
advertisers/adv/lstGETList advertisers with optional sort/limit
campaigns/cam/lstGETList campaigns with optional sort/limit
zones/zon/lstGETList zones with optional sort/limit
statistics/agc/{id}/statistics/{type}/{start}/{end}GETRetrieve stats with limit/page pagination

How do I authenticate with the Revive Adserver API?

The API supports HTTP Basic Authentication where the Authorization header is set to 'Basic ' followed by a base64-encoded string of 'username

'.

1. Get your credentials

The Revive Adserver REST API does not use a traditional 'API key' generated through a dashboard. Instead, it utilizes standard HTTP Basic Authentication. To authenticate, use the username and password associated with your existing Revive Adserver user account. When making requests, include an 'Authorization' header containing the string 'Basic ' followed by the base64-encoded representation of your 'username

'.

2. Add them to .dlt/secrets.toml

[sources.revive_adserver_source] base64_auth = "dXNlcm5hbWU6cGFzc3dvcmQ=" # base64 encoded 'username:password'

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 init uv add "dlt[hub]"

1. Install the dlt AI harness:

uv run dlthub 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:

uv run dlthub ai toolkit install rest-api-pipeline

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 Revive Adserver 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:

uv run python revive_adserver_pipeline.py

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

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

Inspect your pipeline and data:

uv run dlthub 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 cam and zon from the Revive Adserver 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 revive_adserver_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "http://<host-name>/adserver/www/api/v2/rest", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "agencies", "endpoint": {"path": "agc/lst"}}, {"name": "statistics", "endpoint": {"path": "agc/{id}/statistics/{breakdown}/{start}/{end}"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="revive_adserver_pipeline", destination="duckdb", dataset_name="revive_adserver_data", ) load_info = pipeline.run(revive_adserver_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("revive_adserver_pipeline").dataset() sessions_df = data.agencies.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM revive_adserver_data.agencies LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("revive_adserver_pipeline").dataset() data.agencies.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 Revive Adserver 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.


Next steps

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

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-platform — Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for Revive Adserver?

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

Available Pipelines