The full JSONPath functionality as described in this page is available starting with Zabbix 4.0.11.
Overview
JSONPath consists of segments separated with dots. A segment can be either a simple word like a JSON value name,
*
or a more complex construct enclosed within square brackets
[
]
. The separating dot before bracket segment is optional and can be omitted. For example:
$[?(@.name == 'Object')].price.first()
Return the price field of the first object with name 'Object'.
$[?(@.name == 'Object')].history.first().length()
Return the number of history array elements of the first object with name 'Object'.
$[?(@.price > 10)].length()
Return the number of objects with price being greater than 10.
Supported segments
[<start>:<end>]
Match array elements by the defined range:
<start>
- the first index to match (including). If not specified matches all array elements from the beginning. If negative specifies starting offset from the end of array.
<end>
- the last index to match (excluding). If not specified matches all array elements to the end. If negative specifies starting offset from the end of array.
[?(<expression>)]
Match objects/array elements by applying filter expression.
To find a matching segment ignoring its ancestry (detached segment) it must be prefixed with '..' , for example
$..name
or
$..['name']
return values of all 'name' properties.
Since Zabbix 4.0.19 matched element names can be extracted by adding a
~
suffix to the JSONPath. It returns the name of the matched object or an index in string format of the matched array item. The output format follows the same rules as other JSONPath queries - definite path results are returned 'as is' and indefinite path results are returned in array. However there is not much point of extracting the name of an element matching a definite path - it's already known.
Filter expression
Filter expression is a arithmetical expression in infix notation.
Supported operands:
<jsonpath starting with $>
Value referred to by the JSONPath from the input document root node; only definite paths are supported.
$.object.name
<jsonpath starting with @>
Value referred to by the JSONPath from the current object/element; only definite paths are supported.
@.name
Supported operators:
Operator
Description
Result
Functions
Functions can be used at the end of JSONPath. Multiple functions can be chained if the preceding function returns value that is accepted by the following function.
Supported functions:
Quoted numeric values are accepted by the JSONPath aggregate functions since Zabbix 4.0.14. It means that the values are converted from string type to numeric if aggregation is required.
Incompatible input will cause the function to generate error.
Output value
JSONPaths can be divided in definite and indefinite paths. A definite path can return only null or a single match. An indefinite path can return multiple matches, basically JSONPaths with detached, multiple name/index list, array slice or expression segments. However, when a function is used the JSONPath becomes definite, as functions always output single value.
A definite path returns the object/array/value it's referencing, while indefinite path returns an array of the matched objects/arrays/values.
Whitespace
Whitespace (space, tab characters) can be freely used in bracket notation segments and expressions, for example,
$[ 'a' ][ 0 ][ ?( $.b == 'c' ) ][ : -1 ].first( )
.
Strings
Strings should be enclosed with single ' or double " quotes. Inside the strings, single or double quotes (depending on which are used to enclose it) and backslashes
\
are escaped with the backslash
\
character.
