Bugsnag Python API Docs | dltHub

Bugsnag is an error‑monitoring and observability platform that captures and aggregates application errors, sessions, releases, and related telemetry. The REST API base URL is https://api.bugsnag.com and All requests require a personal auth token passed in the Authorization header or as an auth_token query parameter..

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

---

What data can I load from Bugsnag?

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

---

How do I authenticate with the Bugsnag API?

The Data Access API uses personal auth tokens. Include them via Authorization: token YOUR-AUTH-TOKEN header or as the auth_token query parameter. To request version 2, set X-Version: 2 or Accept: application/json; version=2.

1. Get your credentials

1. Sign in to the Bugsnag web UI. 2. Navigate to Settings → My Account (or Account → Personal Auth Tokens). 3. Click “Create token” or “Generate new token”. 4. Give the token a descriptive name and set the desired scopes. 5. Copy the generated token and store it securely; it will be used as Authorization: token <TOKEN> or as the auth_token query parameter.

2. Add them to .dlt/secrets.toml

Copy
[sources.bugsnag_source]
api_key = "your_personal_auth_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 Bugsnag 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 bugsnag_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline bugsnag_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 projects and errors from the Bugsnag 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 bugsnag_source(auth_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.bugsnag.com",
            "auth": {
                "type": "api_key",
                "api_key": auth_token,
            },
        },
        "resources": [
            {"name": "projects", "endpoint": {"path": "projects", "data_selector": "projects"}},
            {"name": "errors", "endpoint": {"path": "projects/{project_id}/errors", "data_selector": "errors"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM bugsnag_data.errors LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("bugsnag_pipeline").dataset()
data.errors.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 Bugsnag 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 token is missing or invalid, the API returns 401 Unauthorized with a JSON body such as { "errors": ["invalid token"] }. Ensure the Authorization: token YOUR-AUTH-TOKEN header or auth_token query parameter is correctly set.

Rate limiting

The API enforces per‑minute limits. Responses include X-RateLimit-Limit and X-RateLimit-Remaining. When the limit is exceeded, a 429 Too Many Requests response is returned along with a Retry-After header indicating when to retry.

Pagination

List endpoints are paginated (default 30 items). Pagination information is provided in the Link response header with rel="next". Use the supplied link to retrieve subsequent pages; do not construct offset parameters manually.

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