- 3 minutes to read

JSON Path search field expression type plugin

Easily extract unique values from JSON messages using the Nodinite JSON Path Search Field Expression Plugin. This page shows you how to configure, test, and use this plugin with clear input, configuration, and result examples.

✅ Extract single or multiple unique values from JSON messages
✅ Use flexible JSON Path expressions to target any element or attribute
✅ Designed for high performance and self-service log views


What is the JSON Path Plugin?

The Nodinite JSON Path plugin lets you extract one or more unique values from the payload (Body) of Log Events. Use it to process messages where data is structured as JSON, making it easy to target specific elements or attributes.

  • Process JSON messages and extract values using JSON Path
  • Target any element or attribute in the JSON structure
  • Ideal for small payloads and business integration scenarios

Use this plugin for extracting values from messages with a JSON format.


How It Works: Input → Expression → Result

Each example below clearly separates the Input (message body), the Expression (JSON Path), and the Result (output values).


Quick Example

Input:

{
  "Orders": [
    { "Id": 101 },
    { "Id": 102 }
  ]
}

Expression:

$..Id

Result:

101
102

Examples

Example 1: Extract Order IDs from JSON Array

Input:

{
  "Orders": [
    { "Id": 101 },
    { "Id": 102 }
  ]
}

Expression:

$..Id

Result:

101
102

Test Expression
Valid expression with state output, unique values, and total count.


Features

  • Extract single or multiple unique values from JSON messages (payload)
  • Use flexible JSON Path expressions to match data
  • Designed for small payloads and high performance

Note: This plugin loads the entire message into RAM. Only use it for small payloads.


How to Use

  1. Select the 'JSON Path' expression type plugin when configuring a Search Field.
  2. Enter the JSON Path expression to extract the desired value(s).
  3. Finalize the configuration and select the Message Types to apply the expression.
  4. Optionally, perform a re-index operation (Add or manage Search Field).

Extracted values are stored for as long as the Message Type retention is configured.


Test Expression

You can test your configuration in the 'Test Expression' tab when setting up a Search Field:

  1. Enter a sample payload in the 'Message Body' tab
  2. Select the 'JSON Path' plugin
    SelectJSON PathPlugin
    Here's an example selecting the 'JSON Path' expression type plugin.
  3. Enter your JSON Path expression (click on elements/attributes to get suggestions)
  4. Review the output and adjust as needed

If the expression is valid, you will see the unique values and total count:

Test Expression
Valid expression with state output, unique values, and total count.

If the expression is invalid or does not match any data, you will see:
No Result
Example of an invalid expression yielding no result.


  • Formula – For advanced options using nested expressions

Mermaid Diagram: Search Field Expression Flow

This diagram shows how the JSON Path plugin fits into the overall search field expression process.

graph LR subgraph "Search Fields" sf(fal:fa-magnifying-glass-plus Order Number) end subgraph "Search Field Expressions" sfe(fal:fa-flask JSON Path plugin) end subgraph "MessageTypes" mt1(fal:fa-file Orders) end sf --- sfe sfe ---|Expression| mt1

Next Step


Learn More