Redash

About Redash

Redash provides an API for programmatic access to its query and dashboard functionality. Authentication uses one of two API key types: a User API Key, which carries the same permissions as the user who owns it, or a Query API Key, scoped only to a specific query and its results; Redash recommends the Query API Key where possible. A Python wrapper called redash-toolbelt is available, with example scripts for polling query results, refreshing dashboards, and exporting queries.

The API exposes endpoints for queries (listing, creating, editing, archiving, and retrieving cached or fresh results), jobs (checking the status of an executing query, with states such as pending, started, success, failure, and cancelled), query results (retrievable as JSON or CSV, including a version accessible without login via an API key in the query string), and dashboards (listing, creating, retrieving, editing, and archiving). Query executions can bypass cached results using a max_age parameter, and parameterized queries accept typed parameters such as numbers, dates, and date ranges in the request body.

This documentation is intended for developers integrating with an existing Redash deployment to automate query execution, retrieve results, or manage dashboards outside the web interface. The listed endpoints are described as an incomplete reference as of Redash V9 and subject to change in future versions.

Key features

• REST API for queries, jobs, dashboards, and query results
• API key authentication with user-level and query-level key scopes
• Poll for cached or fresh query results, with parameterized query support
• Python wrapper library (redash-toolbelt) for common API tasks
• Download query results as CSV or JSON files
• Create, edit, and archive queries and dashboards via API

Frequently asked questions