Class LeadTracker

Lead Tracker

Lead tracker makes it easy to track user activity when they visit listings on your website.

Basic Usage

const sdk = new Rechat.Sdk({
  tracker: {
    cookie: {
      name: 'my-awesome-tracker' // default: rechat-sdk-tracker
    }
  }
})

// track by mlsid
sdk.Leads.Tracker.capture({ mlsid: '1841395151' })

// track by listing id
sdk.Leads.Tracker.capture({ listing_id: '0abf9846-e778-4650-a8e0-6eea207cc3d6' })

Stop Tracking

Call the stop method to disable tracking and remove the cookie.

const sdk = new Rechat.Sdk({
  tracker: false
})

sdk.Leads.Tracker.stop()

Indentify

Rechat automatically assigns the tracker when creating a new lead, but you can also set it manually if you already have the lead Id.


const sdk = new Rechat.Sdk({
  tracker: false
})

sdk.Leads.Tracker.identify(leadId)

Disable Tracking

Set tracker: false to disable tracking. This won’t remove any previously set cookies.

const sdk = new Rechat.Sdk({
  tracker: false
})

Hierarchy (View Summary)

LeadBase
- LeadTracker

Index

Constructors

constructor

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.

Class LeadTracker

Lead Tracker

Basic Usage

Stop Tracking

Indentify

Disable Tracking

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LeadTracker

Methods

capture

Parameters

Returns Promise<void>

createdSearch

Parameters

Returns Promise<void>

favoritedListing

Parameters

Returns Promise<void>

identify

Parameters

Returns void

loggedIn

Parameters

Returns Promise<void>

removedFavoriteListing

Parameters

Returns Promise<void>

removedSearch

Parameters

Returns Promise<void>

searchedListings

Parameters

Returns Promise<void>

sharedListing

Parameters

Returns Promise<void>

signedUp

Parameters

Returns Promise<void>

stop

Returns void

valuedListing

Parameters

Returns Promise<void>

viewedListing

Parameters

Returns Promise<void>

Settings

On This Page