snowplow/snowplow-javascript-tracker

View on GitHub
api-docs/docs/node-tracker/markdown/node-tracker.buildsitesearch.md

Summary

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

[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [buildSiteSearch](./node-tracker.buildsitesearch.md)

## buildSiteSearch() function

Build a Site Search Event Used when a user performs a search action on a page

<b>Signature:</b>

```typescript
declare function buildSiteSearch(event: SiteSearchEvent): PayloadBuilder;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  event | SiteSearchEvent | Contains the properties for the Site Search event |

<b>Returns:</b>

PayloadBuilder

PayloadBuilder to be sent to