Ghost inspector Python API Docs | dltHub

Ghost Inspector is a web UI testing and monitoring platform that runs browser-based tests and provides a public REST API to manage and retrieve tests, suites, and execution results. The REST API base URL is https://api.ghostinspector.com/v1 and All requests require an API key supplied as the apiKey parameter (query string or request body)..

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

---

What data can I load from Ghost inspector?

Here are some of the endpoints you can load from Ghost inspector:

---

How do I authenticate with the Ghost inspector API?

Authentication uses your account API key sent as the apiKey parameter; it may be provided in the query string for GET requests or included in POST form data / JSON body for POSTs.

1. Get your credentials

1. Sign in to Ghost Inspector at https://app.ghostinspector.com.
2. Open Account settings (top‑right menu) → API Keys (or Integrations / API).
3. Copy your API key (labelled apiKey) for use in requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.ghost_inspector_source]
api_key = "your_api_key_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 Ghost inspector 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 ghost_inspector_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline ghost_inspector_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 tests and results from the Ghost inspector 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 ghost_inspector_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.ghostinspector.com/v1",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "tests", "endpoint": {"path": "tests/", "data_selector": "data"}},
            {"name": "results", "endpoint": {"path": "results/{resultId}/", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="ghost_inspector_pipeline",
        destination="duckdb",
        dataset_name="ghost_inspector_data",
    )
    load_info = pipeline.run(ghost_inspector_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("ghost_inspector_pipeline").dataset()
sessions_df = data.tests.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM ghost_inspector_data.tests LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("ghost_inspector_pipeline").dataset()
data.tests.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 Ghost inspector 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 failures

If your API key is missing or invalid the API will return an error (requests require the apiKey parameter). Ensure the api_key in your secrets.toml matches the account API key and include it as ?apiKey=... or in the POST body.

Pagination and count limits

List endpoints support count and offset query parameters. The default count is 10 and the maximum count is 50. Use offset to page through results.

Long‑running executions and immediate parameter

Execute endpoints (/tests/{id}/execute and /suites/{id}/execute) may take significant time; use immediate=1 to trigger execution and return without waiting for results. Responses can take up to ~20 minutes for long runs and may time out.

Common API errors

• invalid_api_key / unauthorized – missing or incorrect apiKey.
• Rate‑limit or timeout errors for long executions.
• Validation errors for malformed requests.

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