UserVoice Python API Docs | dltHub

UserVoice is a feedback and customer voice platform for collecting, organizing and managing product feedback and support data via a REST Admin API. The REST API base URL is https://{subdomain}.uservoice.com/api/v2 and All requests require a Bearer token provided in the Authorization 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 UserVoice data in under 10 minutes.

---

What data can I load from UserVoice?

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

---

How do I authenticate with the UserVoice API?

Use OAuth2 client_credentials to obtain an access token and include it in the Authorization: Bearer header on all requests.

1. Get your credentials

1. Sign in to your UserVoice admin account (your subdomain).
2. In the Developer/API or Admin Integrations section create/register an API client/app with application (client_credentials) grant.
3. Note the client_id and client_secret.
4. Request a token: POST https://{subdomain}.uservoice.com/api/v2/oauth/token with grant_type=client_credentials, client_id and client_secret (and scope if required).
5. Store the returned access_token and use it as Bearer for API requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.user_voice_source]
token = "your_bearer_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 UserVoice 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 user_voice_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline user_voice_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 suggestions and forums from the UserVoice 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 user_voice_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{subdomain}.uservoice.com/api/v2",
            "auth": {
                "type": "bearer",
                "token": token,
            },
        },
        "resources": [
            {"name": "suggestions", "endpoint": {"path": "admin/suggestions", "data_selector": "suggestions"}},
            {"name": "forums", "endpoint": {"path": "admin/forums", "data_selector": "forums"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM user_voice_data.suggestions LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("user_voice_pipeline").dataset()
data.suggestions.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 UserVoice 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 Unauthorized or 403 Forbidden: verify you used the correct subdomain, obtained an access_token via the oauth token endpoint for that subdomain, and sent Authorization: Bearer <token>. Ensure the token hasn’t expired and client credentials are correct.

Rate limiting (429)

UserVoice enforces per‑minute rate limits. Check response headers: X-Rate-Limit-Limit, X-Rate-Limit-Remaining, X-Rate-Limit-Reset. When 429 is returned, use the Retry-After header (unix epoch seconds) before retrying. Consolidate requests with includes/side‑loading and per_page to reduce calls.

Pagination quirks

API supports both cursor‑based and page‑based pagination. Use the pagination.cursor value when present for reliable cursor paging; otherwise use page/per_page. The Link header (rel=next) is provided when more pages exist. Cursor‑based results must start at the beginning and can only be paged forward. per_page default is 20, max 100.

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