Example of JSON Path

For an API call returning content of type application/json, this sample could be part of the reply:

{
    "store": {
        "book": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            },
            {
                "category": "fiction",
                "author": "Herman Melville",
                "title": "Moby Dick",
                "isbn": "0-553-21311-3",
                "price": 8.99
            },
            {
                "category": "fiction",
                "author": "J. R. R. Tolkien",
                "title": "The Lord of the Rings",
                "isbn": "0-395-19395-8",
                "price": 22.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    },
    "expensive": 10
}

To retrieve the color of bicycle element, you can use this JSON path:

$.store.bicycle.color

The resulting value in this case is “red”.

To indicate a specific element of an array, use an index. Counting starts from 0, so book[1] returns the second book object.

To retrieve the all book titles from author "Herman Melville", this JSON path with a filter can be used:

$.store.book[?(@.author=="Herman Melville")].title

The resulting value in this case is "Moby Dick"

If the path points to a list of values (array), the first occurrence is by default selected.

See the details documentation of supported JSON Path expressions here:

github.com/json-path/JsonPath.