@empathyco/x-components/docs/API-reference/api/x-components.queriespreviewactions.fetchquerypreview.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewActions](./x-components.queriespreviewactions.md) &gt; [fetchQueryPreview](./x-components.queriespreviewactions.fetchquerypreview.md)

## QueriesPreviewActions.fetchQueryPreview() method

Requests the results for a query preview, limited by [QueriesPreviewConfig.maxItemsToRequest](./x-components.queriespreviewconfig.maxitemstorequest.md)<!-- -->.

**Signature:**

```typescript
fetchQueryPreview(request: SearchRequest): SearchResponse | null;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  request | SearchRequest | The request object to retrieve the query preview. |

**Returns:**

SearchResponse \| null

A search response based on the query.