Statuspage Python API Docs | dltHub

Statuspage is a service for creating hosted status pages and programmatic management of incidents, components, subscribers, and metrics via a REST API. The REST API base URL is https://api.statuspage.io/v1 and All requests require an API token (API key) provided in the Authorization header or as an api_key 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 Statuspage data in under 10 minutes.

---

What data can I load from Statuspage?

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

---

How do I authenticate with the Statuspage API?

Statuspage uses page/management API tokens. Pass the token in the Authorization header as: Authorization: OAuth <your_api_key> or include ?api_key=<your_api_key> on the request URL. Requests must use HTTPS and the /v1 URL prefix.

1. Get your credentials

1. Log in to your Statuspage account. 2) Click your avatar in the bottom‑left and open "API info" (or Management/API settings). 3) Copy the provided API token (management/page API key). 4) Use that token in Authorization: OAuth or as ?api_key= on requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.statuspage_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 Statuspage 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 statuspage_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline statuspage_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 components and incidents from the Statuspage 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 statuspage_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.statuspage.io/v1",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "components", "endpoint": {"path": "pages/{page_id}/components"}},
            {"name": "incidents", "endpoint": {"path": "pages/{page_id}/incidents"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM statuspage_data.incidents LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("statuspage_pipeline").dataset()
data.incidents.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 Statuspage 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 you receive 401 "Could not authenticate", verify you are using the management/page API token and that it is passed exactly as Authorization: OAuth <token> (or as ?api_key=<token>). Tokens are page‑scoped—ensure the token has access to the requested page.

Rate limiting and pagination

Many list endpoints are paginated (page, per_page or limit) and enforce default/max limits (commonly 100). Check response headers for pagination links; use page/per_page or limit parameters to iterate. Respect HTTP 429 responses if returned; implement exponential backoff.

Common HTTP error codes

• 401 — Could not authenticate (invalid/missing token).
• 403 — Forbidden (insufficient permissions).
• 404 — Resource not found (invalid page_id or resource id).
• 400 — Bad request (invalid parameters).
• 422 — Unprocessable entity (invalid payload on POST/PATCH).
• 429 — Rate limit exceeded (if returned).

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