Load OneStream data to Microsoft Fabric

OneStream Web API is a RESTful service that exposes OneStream Data Automation functions for third-party client applications. Everything needed to build a working OneStream → Microsoft Fabric pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your OneStream to Microsoft Fabric pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the OneStream API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

OneStream API at a glance

These values come from the OneStream API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the OneStream API?

The API uses Bearer token authentication in the Authorization header. Users obtain tokens via external providers (OAuth2/OIDC) or OneStream IdentityServer (personal access tokens).

1. Get your credentials

To obtain credentials for the OneStream REST API, you generally use Personal Access Tokens (PATs) if you are in a OneStream-hosted environment. 1. Log in to the OneStream Identity & Access Management Portal. 2. Navigate to the area for generating Personal Access Tokens (PATs). 3. Generate a new PAT. 4. Copy and store the generated unique identifier string securely (e.g., in a key vault), as you will not be able to retrieve it again after closing the generation screen. If you are in a self-hosted environment, you may alternatively use OAuth 2.0 with supported external providers (Azure AD/Entra ID, Okta, or PingFederate) or configure a REST API encryption key via the OneStream Server Configuration Utility if utilizing the Modern Browser Experience.

2. Add them to .dlt/secrets.toml

Copy
[sources.onestream_source]
onestream_pat_token = "your_pat_identifier_string_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What OneStream data can I load into Microsoft Fabric?

These are the OneStream endpoints dlt can load into Microsoft Fabric:

---

How do I load only new OneStream records?

The OneStream API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

Copy
{"name": "data_provider_adapter", "endpoint": {
    "path": "api/DataProvider/GetAdoDataSetForAdapter",
    # Replace with a field that increases on every write.
    "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated OneStream pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading Authentication/Logon and Authentication/Logoff from the OneStream API into Microsoft Fabric:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def onestream_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{BaseWebServer}/Onestreamapi/api/",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "data_provider_adapter", "endpoint": {"path": "api/DataProvider/GetAdoDataSetForAdapter"}},
            {"name": "data_provider_cube_view", "endpoint": {"path": "api/DataProvider/GetAdoDataSetForCubeViewCommand"}}
        ],
    }
    yield from rest_api_resources(config)


def load_onestream_to_fabric() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="onestream_pipeline",
        destination="fabric",
        dataset_name="onestream_data",
    )
    load_info = pipeline.run(onestream_source())
    print(load_info)


if __name__ == "__main__":
    load_onestream_to_fabric()

Run it with python onestream_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query OneStream data in Microsoft Fabric?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("onestream_pipeline").dataset()
df = data.data_management.df()
print(df.head())

SQL:

Copy
SELECT * FROM onestream_data.data_management LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the OneStream to Microsoft Fabric pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw OneStream loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load OneStream data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack