Cirrus Insight Zynbits Python API Docs | dltHub

Cirrus Insight Zynbits is a REST API that provides organization‑level sharing features such as generating calendar scheduling links and calendar view information. The REST API base URL is https://api.cirrusinsight.com and Requests require an organization key_id (provided by Cirrus Insight) included in the request path..

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 Cirrus Insight Zynbits data in under 10 minutes.

---

What data can I load from Cirrus Insight Zynbits?

Here are some of the endpoints you can load from Cirrus Insight Zynbits:

---

How do I authenticate with the Cirrus Insight Zynbits API?

The Sharing APIs do not use a standard auth header; instead you must enable the Sharing API for your organization and include the provided organization key_id in the request path.

1. Get your credentials

Contact your Cirrus Insight account administrator or Cirrus Insight support to enable the organization's Sharing API. Once enabled, Cirrus Insight will provide a unique key_id (organization identifier) to use in API requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.cirrus_insight_zynbits_source]
key_id = "your_key_id_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 Cirrus Insight Zynbits 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 cirrus_insight_zynbits_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline cirrus_insight_zynbits_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 calendar_views and calendar_views from the Cirrus Insight Zynbits 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 cirrus_insight_zynbits_source(key_id=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.cirrusinsight.com",
            "auth": {
                "type": "api_key",
                "key_id": key_id,
            },
        },
        "resources": [
            {"name": "calendar_views", "endpoint": {"path": "api/organizations/{key_id}/calendarviews?emails_list={emails_list}", "data_selector": "calendarViews"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM cirrus_insight_zynbits_data.calendar_views LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("cirrus_insight_zynbits_pipeline").dataset()
data.calendar_views.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 Cirrus Insight Zynbits 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 / key_id not enabled

If you receive 404 Not Found for a valid‑looking request, verify the organization's Sharing API feature is enabled and that you are using the correct key_id. Contact Cirrus Insight support or your account admin to enable the feature and retrieve the key_id.

Bad request / missing parameters

If you receive 400 Bad Request, ensure the required query parameter emails_list (comma‑separated emails) is present and correctly formatted.

Missing or private endpoints

Many Cirrus Insight developer APIs appear to be behind the developer portal or require feature enablement. If you cannot find other endpoints, sign in to the Cirrus Insight developer portal or contact support for full API access.

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