Nice Expert Help Python API Docs | dltHub

Expert Help is the CXone Mpower Expert (Expert) REST API for programmatic access to site content, users, analytics and integrations. The REST API base URL is https://{hostname}/@api/deki and All requests require an API token supplied via the X-Deki-Token header..

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 Nice Expert Help data in under 10 minutes.

---

What data can I load from Nice Expert Help?

Here are some of the endpoints you can load from Nice Expert Help:

---

How do I authenticate with the Nice Expert Help API?

Integrations use API Tokens (developer/server/OAuth tokens). Include the token in the X-Deki-Token HTTP header for all requests. Request JSON responses by appending dream.out.format=json to the query string.

1. Get your credentials

1. Sign in to your Expert/CXone Mpower Expert site as an Admin.
2. Navigate to Integrations (or Admin → Integrations) → Authorization Tokens / Developer Tokens.
3. Create a new Server or OAuth API Token (choose appropriate scope/role).
4. Save the generated token secret (the API will not return it again).
5. Use the token value in the X-Deki-Token header for API requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.nice_expert_help_source]
deki_token = "your_api_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 Nice Expert Help 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 nice_expert_help_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline nice_expert_help_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 site_query and developer_tokens from the Nice Expert Help 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 nice_expert_help_source(deki_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{hostname}/@api/deki",
            "auth": {
                "type": "api_key",
                "deki_token": deki_token,
            },
        },
        "resources": [
            {"name": "site_query", "endpoint": {"path": "@api/deki/site/query"}},
            {"name": "developer_tokens", "endpoint": {"path": "@api/deki/site/developer-tokens"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM nice_expert_help_data.site_query LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("nice_expert_help_pipeline").dataset()
data.site_query.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 Nice Expert Help 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

Ensure the X-Deki-Token header contains a valid API token. 401 Unauthorized indicates an invalid or missing token; 403 Forbidden indicates insufficient token permissions/role.

Pagination and limits

Many list endpoints support limit and offset query parameters (e.g. ?limit={limit}&offset={offset}). Use these to page through large result sets.

JSON vs XML responses

By default responses are XML. Request JSON by appending dream.out.format=json to the query string. If a specific endpoint defaults to JSON, the endpoint docs will note it.

Rate limiting and errors

The API uses standard HTTP status codes. 4xx indicates client errors (400 bad request, 401 unauthorized, 403 forbidden, 404 not found). 5xx indicates server errors; retry or contact support. Error bodies include fields such as {exception, message, status, title, uri}.

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