snowplow/snowplow-javascript-tracker

View on GitHub
api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.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; [SiteSearchEvent](./node-tracker.sitesearchevent.md)

## SiteSearchEvent interface

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

<b>Signature:</b>

```typescript
interface SiteSearchEvent 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [filters?](./node-tracker.sitesearchevent.filters.md) | Record&lt;string, string \| boolean&gt; | <i>(Optional)</i> Any filters which have been applied to the search |
|  [pageResults?](./node-tracker.sitesearchevent.pageresults.md) | number | <i>(Optional)</i> The number of visible results on the page |
|  [terms](./node-tracker.sitesearchevent.terms.md) | Array&lt;string&gt; | The terms of the search |
|  [totalResults?](./node-tracker.sitesearchevent.totalresults.md) | number | <i>(Optional)</i> The total number of results for this search |