Load Omni Analytics data in Python using dltHub

Build a Omni Analytics-to-database or-dataframe pipeline in Python using dlt with automatic Cursor support.

In this guide, we'll set up a complete Omni Analytics data pipeline from API credentials to your first data load in just 10 minutes. You'll end up with a fully declarative Python pipeline based on dlt's REST API connector, like in the partial example code below:

Example code
@dlt.source
def omni_analytics_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://myorg.omniapp.co/api/v1/schedules/123e4567-e89b-12d3-a456-426614174000",
            "auth": {
                "type": "bearer",
                "token": access_token,
            }
        },
        "resources": [
            "trigger", "resume"
        ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='omni_analytics_pipeline',
        destination='duckdb',
        dataset_name='omni_analytics_data', 
    )
    # Load the data
    load_info = pipeline.run(omni_analytics_source())
    print(load_info)

Why use dltHub Workspace with LLM Context to generate Python pipelines?

  • Accelerate pipeline development with AI-native context
  • Debug pipelines, validate schemas and data with the integrated Pipeline Dashboard
  • Build Python notebooks for end users of your data
  • Low maintenance thanks to Schema evolution with type inference, resilience and self documenting REST API connectors. A shallow learning curve makes the pipeline easy to extend by any team member
  • dlt is the tool of choice for Pythonic Iceberg Lakehouses, bringing mature data loading to pythonic Iceberg with or without catalogs

What you’ll do

We’ll show you how to generate a readable and easily maintainable Python script that fetches data from omni_analytics’s API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

  • SCIM Users: Endpoints related to user management, including retrieving, creating, and filtering users.

    • /api/scim/v2/embed/users: Retrieve embedded user information.
    • /api/scim/v2/users?filter=userName: Filter users by username.
    • /api/scim/v2/users: List all users.
    • /api/scim/v2/users/{userId}: Get details of a specific user by ID.

  • SCIM Groups: Endpoints for managing user groups.

    • /api/scim/v2/groups: List all groups.
    • /api/scim/v2/groups/{groupId}: Retrieve details of a specific group by ID.

  • Schedule Management: Endpoints related to scheduling tasks and operations.

    • /api/v1/schedules: List all schedules.
    • /api/v1/schedules/{scheduleId}: Get details of a specific schedule by ID.
    • /api/v1/schedules?status=success&destination=email: Filter schedules by status and destination.
    • /api/v1/schedules/{scheduleId}/trigger: Manually trigger a specific schedule.
    • /api/v1/schedules/{scheduleId}/resume: Resume a paused schedule.
    • /api/v1/schedules/{scheduleId}/pause: Pause a specific schedule.
    • /api/v1/schedules/{scheduleId}/transfer-ownership: Transfer ownership of a schedule.

You will then debug the Omni Analytics pipeline using our Pipeline Dashboard tool to ensure it is copying the data correctly, before building a Notebook to explore your data and build reports.

Setup & steps to follow

💡
Before getting started, let's make sure Cursor is set up correctly:

Now you're ready to get started!

  1. ⚙️ Set up dlt Workspace

    Install dlt with duckdb support:

    pip install "dlt[workspace]"

    Initialize a dlt pipeline with Omni Analytics support.

    dlt init dlthub:omni_analytics duckdb

    The init command will setup the necessary files and folders for the next step.

  2. 🤠 Start LLM-assisted coding

    Here’s a prompt to get you started:

    Prompt
    Please generate a REST API Source for Omni Analytics API, as specified in @omni_analytics-docs.yaml 
Start with endpoints trigger and resume and skip incremental loading for now. 
Place the code in omni_analytics_pipeline.py and name the pipeline omni_analytics_pipeline. 
If the file exists, use it as a starting point. 
Do not add or modify any other files. 
Use @dlt rest api as a tutorial. 
After adding the endpoints, allow the user to run the pipeline with python omni_analytics_pipeline.py and await further instructions.

  3. 🔒 Set up credentials

    You need to provide a Bearer token for authentication, which you can obtain from your authorization process, and it should be included in the header as 'Authorization: Bearer '.

    To get the appropriate API keys, please visit the original source at https://docs.omni.co/docs/API/connections. If you want to protect your environment secrets in a production environment, look into setting up credentials with dlt.

  4. 🏃‍♀️ Run the pipeline in the Python terminal in Cursor

    python omni_analytics_pipeline.py

    If your pipeline runs correctly, you’ll see something like the following:

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

  5. 📈 Debug your pipeline and data with the Pipeline Dashboard

    Now that you have a running pipeline, you need to make sure it’s correct, so you do not introduce silent failures like misconfigured pagination or incremental loading errors. By launching the dlt Workspace Pipeline Dashboard, you can see various information about the pipeline to enable you to test it. Here you can see:

    • Pipeline overview: State, load metrics
    • Data’s schema: tables, columns, types, hints
    • You can query the data itself
    dlt pipeline omni_analytics_pipeline show

  6. 🐍 Build a Notebook with data explorations and reports

    With the pipeline and data partially validated, you can continue with custom data explorations and reports. To get started, paste the snippet below into a new marimo Notebook and ask your LLM to go from there. Jupyter Notebooks and regular Python scripts are supported as well.

    import dlt

data = dlt.pipeline("omni_analytics_pipeline").dataset()
# get "trigger" table as Pandas frame
data."trigger".df().head()

Extra resources:

Next steps