Web

WebTracker

Defines the tracker class for the web semantic package

Example

To track an event using the web package, you can use the corresponding method on the tracker instance:

Bird.tracker.web.pageViewed(event_props, event_opts);

Extends

• Tracker

Methods

formSubmitted()

formSubmitted(props?: WebFormSubmittedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: WebFormSubmittedProperties

• opts?: BirdEventTrackingOptions

Returns

void

formViewed()

formViewed(props?: WebFormViewedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: WebFormViewedProperties

• opts?: BirdEventTrackingOptions

Returns

void

pageViewed()

pageViewed(props?: WebPageViewedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: WebPageViewedProperties

• opts?: BirdEventTrackingOptions

Returns

void

searchSubmitted()

searchSubmitted(props?: WebSearchSubmittedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: WebSearchSubmittedProperties

• opts?: BirdEventTrackingOptions

Returns

void

---

WebFormSubmittedProperties

Properties for web/form-submitted event

Indexable

[k: string]: unknown

Properties

Property	Type
form_id?	string
step_id?	string

---

WebFormViewedProperties

Properties for web/form-viewed event

Indexable

[k: string]: unknown

Properties

Property	Type
form_id?	string
step_id?	string

---

WebPageViewedProperties

Properties for web/page-viewed event

Indexable

[k: string]: unknown

Properties

Property	Type
path?	string
referrer?	string
search?	string
title?	string
url?	string

---

WebSearchSubmittedProperties

Properties for web/search-submitted event

Indexable

[k: string]: unknown

Properties

Property	Type
search_query?	string
search_results_count?	number