> ## Documentation Index
> Fetch the complete documentation index at: https://bruno-a6972042-mintlify-response-docs-1775161843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Response query

> Query and filter nested response data using dot notation, deep navigation, and array filtering

The `res` object available inside the [vars](../vars), [assertions](../../tests/assertions), [scripting](../getting-started), and [testing](../../tests/introduction) contexts can be invoked as a function to query nested response data.

Think of it as `lodash.get()` on steroids.

```javascript theme={null}
res('order.total')
```

<Info>
  Response query filtering (including `[?]` with filter functions and object predicates) works in both **Safe Mode** and **Developer Mode**.
</Info>

## Examples

```javascript theme={null}
const data = {
  customer: {
    address: {
      city: "bangalore"
    },
    orders: [
      {
        id: "order-1",
        items: [
          { id: 1, amount: 10 },
          { id: 2, amount: 20 }
        ]
      },
      {
        id: "order-2",
        items: [
          { id: 3, amount: 30 },
          { id: 4, amount: 40 }
        ]
      }
    ]
  },
};
```

| Query                                   | Output                              |
| --------------------------------------- | ----------------------------------- |
| res("customer.address.city")            | bangalore                           |
| res("customer.orders.items.amount")     | \[10, 20, 30, 40]                   |
| res("customer.orders.items.amount\[0]") | 10                                  |
| res("..items.amount")                   | \[10, 20, 30, 40]                   |
| res("..amount")                         | \[10, 20, 30, 40]                   |
| res("..items.amount\[0]")               | 10                                  |
| res("..items\[0].amount")               | 10                                  |
| res("..items\[5].amount")               | undefined                           |
| res("..id")                             | \["order-1", 1, 2, "order-2", 3, 4] |
| res("customer.orders.foo")              | undefined                           |
| res("..customer.foo")                   | undefined                           |
| res("..address")                        | \[\{ city: "bangalore" }]           |
| res("..address\[0]")                    | \{ city: "bangalore" }              |

## API

### Standard dot notation

```javascript theme={null}
res('customer.orders.items.amount')
```

### Deep navigation with double dots

```javascript theme={null}
res('..items.amount')
```

### Array indexing

```javascript theme={null}
res('..items[0].amount')
```

### Array filtering with a filter function

Use `[?]` with a corresponding filter function to select matching items.

```javascript theme={null}
res('..items[?].amount', i => i.amount > 20)
```

### Array filtering with an object predicate

Use `[?]` with an object to match items by property values. This is equivalent to `i => i.id === 2 && i.amount === 20`.

```javascript theme={null}
res('..items[?]', { id: 2, amount: 20 })
```

### Array mapping with a mapper function

Use `[?]` with a function that returns a transformed value to map over items.

```javascript theme={null}
res('..items..amount[?]', amt => amt + 10)
```