Comment on page
Integrations & API
All the API calls support authentication with an API key. The application has two types of API keys:
- User API Key: has the same permissions as the user who owns it. Can be found on a user profile page.
- Query API Key: has access only to the query and its results. Can be found on the query page.
Whenever possible we recommend using a Query API key.
We provide a light wrapper around the application API called
redash-toolbelt. It’s a work-in-progress. The source code is hosted on Github. The
examplesfolder in that repo includes useful demos, such as:
Below is an incomplete list of API endpoints. These may change in future versions of the application.
Each endpoint is appended to your application's base URL. For example:
- GET: Returns a paginated array of query objects.
- Includes the most recent
query_result_idfor non-parameterized queries.
- POST: Create a new query object
- GET: Returns an individual query object
- POST: Edit an existing query object.
- DELETE: Archive this query.
- GET: Get a cached result for this query ID.
- Only works for non parameterized queries. If you attempt to GET results for a parameterized query you’ll receive the error:
no cached result found for this query. See POST instructions for this endpoint to get results for parameterized queries.
- POST: Initiates a new query execution or returns a cached result.
- The API prefers to return a cached result. If a cached result is not available then a new execution job begins and the job object is returned. To bypass a stale cache, include a
max_agekey which is an integer number of seconds. If the cached result is older than
max_age, the cache is ignored and a new execution begins. If you set
0this guarantees a new execution.
- If passing parameters, they must be included in the JSON request body as a
//Here’s an example JSON object including different parameter types:
- GET: Returns a query task result (job)
- Possible statuses:
- 1 == PENDING (waiting to be executed)
- 2 == STARTED (executing)
- 3 == SUCCESS
- 4 == FAILURE
- 5 == CANCELLED
- When status is success, the job will include a
- GET: Returns a query result
- Appending a filetype of
.jsonto this request will return a downloadable file. If you append your
api_keyin the query string, this link will work for non-logged-in users.
- GET: Returns a paginated array of dashboard objects.
- POST: Create a new dashboard object
- GET: Returns an individual dashboard object.
- DELETE: Archive this dashboard
- POST: Edit an existing dashboard object.