Overview
JSONata is a query and tranformation language for JSON data. It allows you to declare the output using queries, operators and functions while formatting and parsing the data on the fly.
The official documentation does a great job of explaining the details of the language and providing a tool to test your JSONata expressions.
JSONata Expression Examples
To get a feel for what you can do with JSONata. Here are a couple of helpful examples to demonstrate how you can manipulate your data.
Simple Queries
We will start by looking at a few important queries and operations that can be applied to a typical Meraki API response.
Using the JSON from the API response, we can explore the data with some simple JSONata queries.
| Description | JSONata | Result |
|---|---|---|
| Root of JSON | $ |
{object} |
| List all values by property name | id |
["L_646829496481087792","L_646829496481091801"] |
| Array Item | productTypes[0] |
"appliance" |
| Array Items | productTypes[] |
["appliance","camera","switch","systemsManager","wireless"] |
^ Sorting
The ^ operation will sort the results based on a property name, where the thing to be sorted is within parenthesis. ^(sortMe)
In this example, the Device Statuses are being sorted on the status value. Using the . map operation, a new array of objects will be created. The serial and status fields are then defined to be used in the new JSON.
Update Values
Update properties and add custom markup.
In this example the data is being formatted to look nicer in a table.
The id property is mapped to ID and the productTypes are now called Products. The Network property is an HTML hyperlink using the url property for the href address and then displaying the name.
Filtering Data
Filter properties by value.
In this example we list only clients that have the manfuacturer name of "Cisco Meraki"
