snowplow/snowplow-javascript-tracker

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

## buildPagePing() function

Build a Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view

<b>Signature:</b>

```typescript
declare function buildPagePing(event: PagePingEvent): PayloadBuilder;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  event | PagePingEvent | Contains the properties for the Page Ping event |

<b>Returns:</b>

PayloadBuilder

PayloadBuilder to be sent to