JSON Data source
JSON Data source provides a quick and flexible way to issue queries to arbitrary RESTful endpoints that return JSON data.
Create the JSON Data source
The first step is to create the data source and provide basic auth
credentials. Note that basic auth credentials are optional, and you can provide a bearer token if that is your means of authenticating against the API
Writing queries
In the query editor, select the JSON data source created above and enter the query parameters. The query parameters use the YAML syntax. For E.g.
Providing HTTP Options
The following HTTP options are used for sending a query
The URL parameter is the only required parameter
url
- This is the URL where the RESTful API is exposedmethod
- the HTTP method to use (default:get
)headers
- a dictionary of headers to send with the requestauth
- basic auth username/password (should be passed as an array:[username, password]
)params
- a dictionary of query string parameters to add to the URLdata
- a dictionary of values to use as the request bodyjson
- same asdata
except that it’s being converted to JSON
Filtering response data: path and fields
The response data can be filtered by specifying the path
and fields
parameters. The path
filter allows accessing attributes within the response, for e.g. if a key foo
in the response contains rows of objects you want to access, specifying path
foo
will convert each of the objects into rows.
In the example below, we are then selecting fields
volumeInfo.authors, volumeInfo.title, volumeInfo.publisher and accessInfo.webReaderLink
The resulting data from the above query is a nicely formatted table that can be searched in Apica Ascent or made available as a widget in a dashboard
Last updated