keypath

Written as keypath(argnum flags):options in a transform expression.

Minimum arguments	1
Maximum arguments	1
Default arguments	1
Argument modes	SINGLE_PRIMITIVE, SINGLE_ARRAY, SINGLE_DICT

Documentation

Extract data from JSON objects or JSON strings using a keypath expression.

The keypath syntax supports:

• Dot notation for nested objects (e.g. “user.address.city”)
• Array indexing (e.g. “users[0].name”)

Flags

Flag	Letter
spread_output	S
noncaptive_input	I

Examples

Basic usage

Input args: [{"user":{"name":"Alice","age":30}}]
Transforms: "keypath:user.name"
Output: "Alice"

Array access

Input args: [{"items":[{"id":1},{"id":2}]}]
Transforms: "keypath:items[0].id"
Output: 1

With JSON string input

Input args: ["{\"user\": {\"name\": \"Alice\"}}"]
Transforms: "keypath:user.name"
Output: "Alice"