Sometimes you need to visualize data not contained in an RDBMS or NOSQL data store, but available from some HTTP API. For those times, Redash provides the
JSON data source (first introduced in Redash v8).
Redash treats all incoming data from the
JSON data source as text; so you should be prepared to use table formatting when rendering the data.
JSON Data Source Type
JSON Data Source to query arbitrary JSON API’s. Setup is easy because no authentication is needed. Any RESTful JSON API will handle authentication through HTTP headers. So just create a new Data Source of type
JSON and name it whatever you like (“JSON” is a good choice).
Redash will detect data types supported by JSON (like numbers, strings, booleans), but others (mostly date/timestamp) will be treated as strings (unless specified in ISO-8601 format).
This Data Source takes queries in YAML format. Here’s some examples using the GitHub API:
Return a list of objects from an endpoint
This will return the result of the above API call as is.
Return a single object
The above API call returns a single object, and this object is being converted to a row.
Return Specific Fields
In case you want to pick only specific fields from the resulting object(s), you can pass the
fields: [number, title]
Return an inner object
Many JSON API’s return arrays of nested objects. You can access an object in an array with the
The above query will use the
assignee objects from the API result as the query result.
Pass query string parameters
You can either craft your own URLs, or you can pass the
q: is:open type:pr repo:getredash/redash
The above is the same as:
Additional HTTP Options
You can pass additional keys to modify various HTTP options:
method - the HTTP method to use (default:
headers - a dictionary of headers to send with the request
auth - basic authentication username/password (should be passed as an array:
params - a dictionary of query string parameters to add to the URL
data - a dictionary of values to use as request body
json - same as
data except that it’s being converted to JSON
URL Data Source Type
URL data source type is deprecated since Redash v8. You can still use existing data sources created with this type, but you can’t create new ones. We recommend migrating to the JSON data source type.
URL data source expects your endpoints to return JSON with a special data structure (see below).
The body of your query will include only the URL that returns data, for example:
To manipulate the data (filter, sort, aggregate etc.) you can use the Query Results Data Source.
Required Data Structure
The returned object must expose two keys:
name keys described in your
The following data types are supported for columns:
An example of returned data appears below: