Class LeadTracker

Records visitor activity — viewed a listing, searched, signed up — onto a lead's timeline. The lead is identified via a tracking cookie, set automatically when LeadCapture.capture creates a lead.

See the Lead Tracker guide.

Hierarchy (View Summary)

LeadBase
- LeadTracker

Index

Constructors

Methods

capture createdSearch favoritedListing identify loggedIn removedFavoriteListing removedSearch searchedListings sharedListing signedUp stop valuedListing viewedListing

Constructors

constructor

new LeadTracker(settings: ISdkSettings): LeadTracker
Initializes a LeadTracker instance with the provided SDK settings.
Parameters
- settings: ISdkSettings
  The configuration object for the SDK. ISdkSettings
Returns LeadTracker
Overrides LeadBase.constructor

Methods

capture

capture(payload: ITrackPayload): Promise<void>
Captures a user's interaction.
Parameters
- payload: ITrackPayload
  The payload containing tracking event details.
Returns Promise<void>
Promise that resolves on successful capture or rejects on failure.

createdSearch

createdSearch(search: ITrackSearchPayload, notes: string): Promise<void>
Tracks when a user creates a saved search.
Parameters
- search: ITrackSearchPayload
  The search criteria to track.
- notes: string
  Notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

favoritedListing

favoritedListing(listing: ITrackListingPayload, notes?: string): Promise<void>
Tracks when a user favorites a listing.
Parameters
- listing: ITrackListingPayload
  The listing data to track.
- Optionalnotes: string
  Optional notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

identify

identify(id: string): void
Saves the user's unique identifier in a tracking cookie.
Parameters
- id: string
  Unique identifier for the lead.
Returns void

loggedIn

loggedIn(notes?: string): Promise<void>
Tracks when a user logs in.
Parameters
- Optionalnotes: string
  Optional notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

removedFavoriteListing

removedFavoriteListing(
listing: ITrackListingPayload,
notes?: string,
): Promise<void>
Tracks when a user removes a listing from favorites.
Parameters
- listing: ITrackListingPayload
  The listing data to track.
- Optionalnotes: string
  Optional notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

removedSearch

removedSearch(search: ITrackSearchPayload, notes: string): Promise<void>
Tracks when a user removes a saved search.
Parameters
- search: ITrackSearchPayload
  The search criteria to track.
- notes: string
  Notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

searchedListings

searchedListings(search: ITrackSearchPayload, notes: string): Promise<void>
Tracks when a user searches for listings.
Parameters
- search: ITrackSearchPayload
  The search criteria to track.
- notes: string
  Notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

sharedListing

sharedListing(listing: ITrackListingPayload, notes?: string): Promise<void>
Tracks when a user shares a listing.
Parameters
- listing: ITrackListingPayload
  The listing data to track.
- Optionalnotes: string
  Optional notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

signedUp

signedUp(notes?: string): Promise<void>
Tracks when a user signs up.
Parameters
- Optionalnotes: string
  Optional notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

stop

stop(): void
Removes all stored tracking data, including cookies, to stop tracking.

Returns void

valuedListing

valuedListing(listing: ITrackListingPayload, notes?: string): Promise<void>
Tracks when a user values or rates a listing.
Parameters
- listing: ITrackListingPayload
  The listing data to track.
- Optionalnotes: string
  Optional notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.

viewedListing

viewedListing(listing: ITrackListingPayload, notes?: string): Promise<void>
Tracks when a user views a listing.
Parameters
- listing: ITrackListingPayload
  The listing data to track.
- Optionalnotes: string
  Optional notes for additional context.
Returns Promise<void>
Promise that resolves on successful capture.