Real Estate Objects and Events

A Lead Booster Analytics API package is a set of events, objects, and rules that set boundaries on the framework used by the Lead Booster algorithms to parse lead behavior and predict their engagement and timing thresholds. The tracked events are also used to generate reports for admins and agents in the Analytics dashboard and the Lead Booster product.

The real estate package contains all user events that may be performed on a real estate website.

Packages are stored as JSON files and are accessible from the Brytecore CDN. You can also view the open source project for this package on GitHub.

Package Dependencies

This package depends on many events defined in the Core package and objects defined in the default schemas.

The Lead Booster API library automatically loads the Core package and default schemas. However, you may need to reference the object and event structure when using this package.

Namespace

Every event in this package must use the realestate namespace. Whenever you log an event, the event name should be preceded with realestate., as in this example.

brytescore( "realestate.viewedListing", listingObject );

Object Schemas

This package includes some default object schemas that can be used inside your event data parameter object. These define optional JavaScript standard objects that can be created to simplify repeated calls to the Brytescore API. For example, if you log viewedListing, calcMortgagePayment, and likedListing on the same page, you may wish to create a listing object to pass with these events, instead of manually adding each listing property to the data object.

The real estate package contains five object schemas, listing, neighborhood, pointOfInterest, realEstateForm and search.

listing Object

The listing object is a single property for sale or rent. It can be passed to any of the listing events supported by this package.

Field Type Required Description
address address yes The listing address
bedrooms number no The number of bedrooms
features array of string no The MLS features on this property
fullBaths number no The number of full baths
geoLocation geo no The geoLocation (latitude/longitude) of this property
halfBaths number no The number of half baths
isAcreage boolean no This property contains acreage
isCondo boolean no This property is a condominium
isForeclosure boolean no This property is distressed
isLot boolean no This property is land or a lot
isMultiFamily boolean no This property is a multi-family residence
isRental boolean no This property is for lease
isSingleFamily boolean no This property is a single-family residence
listingURL uri no The link to the page containing details about this property
mlsId string yes The unique ID of this property from the Multiple Listing Service
neighborhood neighborhood no The neighborhood (not subdivision) the property is within
photoURL uri no The primary photo of the property
price number yes The offered value of the property for sale or rent
schoolElementary string no The elementary school district in which this property resides
schoolHigh string no The high school district in which this property resides
schoolMiddle string no The middle school district in which this property resides
squareFeet number no The square footage of the property
subdivision string no The subdivision of which this property is a part
/* Example use of the listing object */

// Create a variable to store the address
var address = {
	"streetAddress": "196 Humperdink Lane",
	"city": "Florin City",
	"stateProvince": "Florin",
	"postalCode": "00990"
};

// Create a variable to store the geoLocation
var geo = {
	"latitude": 33.859821,
	"longitude": -84.168221
};

// Create a variable storing the listing object
var listing = {
	"address": address,
	"features": [
		"Interior: Master on main",
		"Interior: Hardwood floors",
		"Interior: Fireplace",
		"Exterior: Level lot",
		"Exterior: Deck/Patio",
		"Exterior: Fenced yard",
		"Garage/Parking: 3 car or more",
		"Garage/Parking: Attached"
	],
	"fullBaths": 3,
	"geoLocation": geo,
	"halfBaths": 1,
	"isSingleFamily": true,
	"price": 349000,
	"listingURL": "http://www.yoursite.com/listings/2983599/",
	"mlsId": "2983599",
	"photoURL": "http://images.yoursite.com/2983599_1.jpg"
};

// Build a data object
var data = {
	"listing": listing
};

// Attach the save event to the saveButton click
document.getElementById('saveButton').addEventListener('click', function () {
	brytescore( "realestate.savedListing", data );
});

// Log the viewedListing event on document load
document.addEventListener('DOMContentLoaded', function() {
	brytescore( "realestate.viewedListing", data );
});

neighborhood Object

Neighborhoods are geographic communities within a town, suburb, city or rural area. Generally considered more social than legal, neighborhood boundaries may not be agreed upon by its residents.

Neighborhoods are not the same as MLS-defined subdivisions, which are comprised of legally subdivided lots of land.

Field Type Required Description
name string yes The name of the neighborhood.
boundaries array of geo no The geographic boundaries of the neighborhood.
/* neighborhood example */

var bounds = [
	{"latitude": -84.49941, "longitude": 33.593284},
	{"latitude": -84.497209, "longitude": 33.593146},
	{"latitude": -84.499428, "longitude": 33.590944},
	{"latitude": -84.50412, "longitude": 33.589757},
	...
	{"latitude": -84.584384, "longitude": 33.629605}
];

var hood = {
	"name": "Hill Valley",
	"boundaries": bounds
}

pointOfInterest Object

A point of interest is a specific location that someone may find useful or interesting. Examples may include anything from landmarks to scenic views to rest areas.

Field Type Required Description
name string yes The name of the point of interest.
address address no The physical address of the point of interest.
/* pointOfInterest example */

var address = {
	"streetAddress": "Euston Road",
	"streetAddress2": "Platform 9¾",
	"city": "London",
	"stateProvince": "England",
	"postalCode": "N1 9AL",
	"country": "UK"
};

var poi = {
	"name": "Hogwarts School of Witchcraft and Wizardry",
	"address": address
};

realEstateForm Object

A user-submitted data entry form. Contains properties for common real estate form fields.

Field Type Required Description
agentName string no The name of the sender's agent
fromEmail email no The email address of the sender
fromName string no The name of the sender
fromTelephone telephone no The telephone number(s) of the sender
isPrequalified boolean no The sender is prequalified for a mortgage
isWorkingWithAgent boolean no The sender is working with an agent
message string no The contents of the message provided by the sender
name string no The name of the form (ex: contact, about, etc)
relatedListing listing no The listing related to this form submission
subject string no The subject of the form or email
toEmail email no The email address of the person to which the form was sent
toName string no The name of the person to which the form was sent
/* realEstateForm example */

var listing = {
	"price": 349000,
	"mlsId": "2983599"
	...
};

var form = {
	"fromEmail": "frank@fllngwtr.com",
	"fromName": "Frank Wright",
	"fromTelephone": {
		"mobile": "555.867.5309"
	},
	"isPreQualified": false,
	"isWorkingWithAgent": false,
	"message": "Hi, I need an agent to sell my historic home in Pennsylvania.",
	"name": "agent-contact-form",
	"subject": "Looking for an agent",
	"toEmail": "agent@yourcompany.com",
	"toName": "Suzie Agent",
	"relatedListing": listing
};

search Object

The object containing details about a specific real estate property search the user performed.

Field Type Required Description
address address no The address a user entered into the search
bedroomsMax number no The maximum number of bedrooms used in this search
bedroomsMin number no The minimum number of bedrooms used in this search
cities array of string no The cities the user searched within
counties array of string no The counties the user searched within
description string no A human-readable text description of this search
driveTimeStartAddress address no Start location for the drive in a drive time search
driveTimeStartTime string no Time of day of the drive in a drive time search
features array of string no The features the user selected for this search
fullBathsMax number no The maximum number of full bathrooms used in this search
fullBathsMin number no The minimum number of full bathrooms used in this search
halfBathsMax number no The maximum number of half bathrooms used in this search
halfBathsMin number no The minimum number of half bathrooms used in this search
id string no The website's internal unique identifier for this search
isAcreage boolean no This search was for acreage
isCondo boolean no This search was for condominiums
isDriveTimeSearch boolean no This search contains "drive time" criteria
isForeclosureAcreage boolean no This search was for distressed properties
isLot boolean no This search was for land or lots
isMultiFamily boolean no This search was for multi-family residences
isPointOfInterestSearch boolean no This search returned results near a point of interest
isRadiusSearch boolean no This search was for a specific radius
isRental boolean no This search was for leases
isSingleFamily boolean no This search was for single-family residences
isWalkTimeSearch boolean no This search contains "walk time" criteria
mlsIds array of string no The list of MLS IDs used in the search
neighborhood neighborhood no The neighborhood the results are within
pointOfInterest pointOfInterest no The pointOfInterest used in a point of interest search
postalCodes array of string no The postal or zip codes passed to the search
priceMax number no The maximum price of the search
priceMin number no The minimum price of the search
radiusGeoLocation geo no The geoLocation used as the center of the radius search
radiusInMiles number no The radius of the radius search
radiusSearchAddress address no The address used as the center of a radius search
resultsCount number no The total number of results returned by the search
schoolElementary string no The elementary school district the user searched within
schoolHigh string no The high school district the user searched within
schoolMiddle string no The middle school district the user searched within
searchURL uri no The hyperlink to this search
similarTo listing no Searched for homes similar to provided listing
sortedBy array of accepted values† no An array of items the results are sorted by
subdivision string no The name of the subdivision used in the search
walkTimeStartAddress address no Start location for the walk in a walk time search
walkTimeStartTime string no Time of day of the walk in a walk time search
yearBuiltMax number no The latest year homes in this search were built
yearBuiltMin number no The earliest year homes in this search were built


† Accepted Values for realestate.search.sortBy

Value Description
priceHighest Sorted by price, highest to lowest
priceLowest Sorted by price, lowest to highest
address Sorted by street address
distanceClosest Sorted by proximity to radius or point of interest
distanceFurthest Sorted by distance from radius of point of interest, furthest to closest
photoCountHighest Sorted by number of photos, most to least
photoCountLowest Sorted by number of photos, least to most
bedroomsHighest Sorted by bathrooms, most to least
bedroomsLowest Sorted by bedrooms, least to most
bathroomsHighest Sorted by bathrooms, most to least
bathroomsLowest Sorted by bathrooms, least to most
squareFeetHighest Sorted by square feet, highest to lowest
squareFeetLowest Sorted by square feet, lowest to highest
yearBuiltNewest Sorted by year built, newest to oldest
yearBuiltOldest Sorted by year built, oldest to newest
dateListedNewest Sorted by listing date, newest to oldest
dateListedOldest Sorted by listing date, oldest to newest
featuredListings Sorted by featured listings
other Any unlisted field
/* Example use of the search object */

// Create the search object
var search = {
	"bedroomsMin": 4,
	"fullBathsMin": 2,
	"isCondo": true,
	"isSingeFamily": true,
	"priceMax": 450000,
	"searchURL": "http://www.yourwebsite.com/listings?beds=4&baths=2&condo=1&single=1&minprice=450000"
};

var data = {
	"search": search
};

// Attach the save event to the saveButton click
document.getElementById('saveButton').addEventListener('click', function () {
	brytescore( "realestate.savedSearch", data );
});

// Log the viewedListing event on document load
document.addEventListener('DOMContentLoaded', function() {
	brytescore( "realestate.searchedListings", data );
});

Changes to Authentication Events

The core Authentication Events are slightly modified for real estate. The userClassification property is an enum, changed from a string.

Valid values for userClassification are agent, staff, and lead.

Listing Events

deletedSavedListing

The user deleted one of his/her saved listings.

See also: savedListing

Parameter Type Required Description
listing listing yes The saved listing data
/* deletedSavedListing example */

brytescore( "realestate.deletedSavedListing", { "listing": listing } );

dislikedListing

The user 'disliked' a listing.

See also: likedListing

Parameter Type Required Description
listing listing yes The listing that was disliked
reason string no The reason for disliking the listing
/* dislikedListing example */

var data = {
	"listing": listing,
	"reason": "Bedrooms look too small. No double ovens."
};

brytescore( "realestate.dislikedListing", data );

hidListing

The user hid a listing from search results. This listing will no longer display when future searches are performed.

See also: unhidListing

Parameter Type Required Description
listing listing yes The listing that was hidden
/* hidListing example */

brytescore( "realestate.hidListing", { "listing": listing } );

likedListing

The user 'liked' a listing.

See also: dislikedListing

Parameter Type Required Description
listing listing yes The listing that was liked
reason string no The reason for liking the listing
/* likedListing example */

var data = {
	"listing": listing,
	"reason": "Big bedrooms. Double ovens."
}

brytescore( "realestate.likedListing", data );

listingImpression

The listing was displayed in a page of search results. This should only be logged if the listing was actually on the user's screen. It is not unusual to log this event many times per searchedListings event, depending on your website's search results pagination rules.

See also: viewedListing

Parameter Type Required Description
listing listing yes The listing
/* listingImpression example */

brytescore( "realestate.listingImpression", { "listing": listing } );

playedListingVideo

The user played a video about a listing.

Parameter Type Required Description
listing listing no The listing to which this video is related.
videoUrl uri no The URL of the video
/* playedListingVideo example */

var data = {
	"listing": listing,
	"videoUrl": "https://www.youtube.com/watch?v=KnB4FOCgfKs"
};

brytescore( "realestate.playedListingVideo", data );

printedDrivingDirections

The user printed driving directions to a listing.

See also: viewedDrivingDirections

Parameter Type Required Description
listing listing yes The listing the user was viewing when the directions were printed
startAddress address yes The starting address for the directions
/* printedDrivingDirections example */

var data = {
	"listing": listing,
	"startAddress": address
};

brytescore( "realestate.printedDrivingDirections", data );

printedListing

The user printed the details of a listing.

See also: printedListingFlyer

Parameter Type Required Description
listing listing yes The listing that was printed
/* printedListing example */

brytescore( "realestate.printedListing", { "listing": listing } );

printedListingFlyer

The user printed an online flyer for the listing.

See also: printedListing, viewedListingFlyer

Parameter Type Required Description
listing listing yes The listing that was printed
/* printedListingFlyer example */

brytescore( "realestate.printedListingFlyer", { "listing": listing } );

ratedListing

The user rated a listing.

Parameter Type Required Description
listing listing yes The listing that was rated
rating string yes The rating provided by the user
/* ratedListing example */

var data = {
	"listing": listing,
	"rating": "4 Stars"
};

brytescore( "realestate.ratedListing", data );

requestedInfo

The user submitted a request for more information about a listing.

Parameter Type Required Description
form realEstateForm yes The form data the user submitted
/* requestedInfo example */

brytescore( "realestate.requestedInfo", { "form": form } );

requestedShowing

The user requested a showing for a listing.

Parameter Type Required Description
form realEstateForm yes The form data the user submitted
requestedDateTime date-time yes The date and time the user wishes to visit the listing (ISO 8601 String)
/* requestedShowing example */

// Note that Date.toISOString returns a UTC time, so if the below code
// is run in the Eastern time zone, you will get "2015-12-10T21:30:00.000Z"

var requestedDate = new Date("12/10/2015 16:30");
requestedDate = requestedData.toISOString();

var data = {
	"form": form,
	"requestedDateTime": requestedDate
};

brytescore( "realestate.requestedShowing", data );

savedListing

The user saved a listing.

See also: deletedSavedListing

Parameter Type Required Description
listing listing yes The listing that was saved
/* savedListing example */

brytescore( "realestate.savedListing", { "listing": listing } );

sharedListingEmail

The user shared a listing via an email form

Parameter Type Required Description
form realEstateForm yes The form data submitted by the user
/* sharedListingEmail example */

brytescore( "realestate.sharedListingEmail", { "form": form } );

sharedListingFacebook

The user shared a listing via Facebook

Parameter Type Required Description
listing listing yes The listing that was shared
/* sharedListingFacebook example */

brytescore( "realestate.sharedListingFacebook", { "listing": listing } );

sharedListingTwitter

The user shared a listing via Twitter

Parameter Type Required Description
listing listing yes The listing that was shared
/* sharedListingTwitter example */

brytescore( "realestate.sharedListingTwitter", { "listing": listing } );

subscribedListingUpdates

The user requested to receive email updates whenever this listing data is updated.

See also: unsubscribedListingUpdates

Parameter Type Required Description
email email yes The user's email account that will receive updates
listing listing yes The listing being tracked
frequency string no How frequently the user gets updates
/* subscribedListingUpdates example */

var data = {
	"email": "freddie@atlantafalcons.com",
	"listing": listing,
	"frequency": "semi-weekly"
};

brytescore( "realestate.subscribedListingUpdates", data );

unhidListing

The user unhid a listing that was previously hidden from future search results.

See also: hidListing

Parameter Type Required Description
listing listing yes The listing that was unhidden
/* unhidListing example */

brytescore( "realestate.unhidListing", { "listing": listing } );

unsubscribedListingUpdates

The user unsubscribed from email updates about this listing.

See also: subscribedListingUpdates

Parameter Type Required Description
listing listing yes The listing
/* unsubscribedListingUpdates example */

brytescore( "realestate.unsubscribedListingUpdates", { "listing": listing } );

viewedDrivingDirections

The user viewed driving directions to a listing.

See also: printedDrivingDirections]See also: viewedDriveTime]

Parameter Type Required Description
listing listing yes The listing the user is driving to
startAddress address yes The starting address for the directions
/* viewedDrivingDirections example */

var data = {
	"listing": listing,
	"startAddress": address
};

brytescore( "realestate.viewedDrivingDirections", data );

viewedListing

A user viewed the details on a listing.

See also: listingImpression, viewedSavedListing

Parameter Type Required Description
listing listing yes The listing that was viewed
/* viewedListing example */

brytescore( "realestate.viewedListing", { "listing": listing } );

viewedListing3DTour

A user viewed an interactive 3D tour of a listing.

See also: viewedListingVirtualTour

Parameter Type Required Description
listing listing yes The listing for which the 3D tour was viewed
/* viewedListing3DTour example */

brytescore( "realestate.viewedListing3DTour", { "listing": listing } );

viewedListingFlyer

Viewed an online flyer for a listing.

See also: printedListingFlyer

Parameter Type Required Description
listing listing yes The listing for which the flyer was viewed
/* viewedListingFlyer example */

brytescore( "realestate.viewedListingFlyer", { "listing": listing } );

viewedListingMap

The user viewed a map showing the position of a specific listing.

Parameter Type Required Description
listing listing no The listing plotted on the map
/* viewedListingMap example */

brytescore( "realestate.viewedListingMap", listing );

viewedListingPhoto

A user clicked on and viewed a specific listing photo.

Parameter Type Required Description
listing listing yes The listing that was viewed
viewedPhotoURL uri no The URL of the photo viewed
/* viewedListingPhoto example */

var data = {
	"listing": listing,
	"viewedPhotoURL": "http://www.yoursite.com/listing/223445/images/1/medium"
};

brytescore( "realestate.viewedListingPhoto", data );

viewedListingVirtualTour

A user viewed a virtual tour for a listing.

See also: viewedListing3DTour

Parameter Type Required Description
listing listing yes The listing for which the virtual tour was viewed
/* viewedListingVirtualTour example */

brytescore( "realestate.viewedListingVirtualTour", { "listing": listing } );

viewedSavedListing

A user clicked on and viewed one of his/her saved listings.

See also: savedListing, viewedListing

Parameter Type Required Description
listing listing yes The listing that was viewed
/* viewedSavedListing example */

brytescore( "realestate.viewedSavedListing", { "listing": listing } );

Search Events

These events all pertain to a specific search performed by the user.

deletedSavedSearch

A user deleted a search he/she had previously saved.

See also: savedSearch

Parameter Type Required Description
search search yes The previously saved search that was deleted
/* deletedSavedSearch example */

brytescore( "realestate.deletedSavedSearch", { "search": search } );

printedSearchResults

A user printed a list of search results.

Parameter Type Required Description
search search yes The search that was printed
/* printedSearchResults example */

brytescore( "realestate.printedSearchResults", { "search": search } );

quickSearchedListings

A user used a 'quick search' form to run a search.

See also: searchedListings

Parameter Type Required Description
search search yes The search that was executed
/* quickSearchedListings example */

brytescore( "realestate.quickSearchedListings", { "search": search } );

savedSearch

A user saved a search.

See also: deletedSavedSearch

Parameter Type Required Description
search search yes The search that was saved
/* savedSearch example */

brytescore( "realestate.savedSearch", { "search": search } );

searchedListings

A user executed a listing search.

See also: quickSearchedListings

Parameter Type Required Description
search search yes The search that was executed
/* searchedListings example */

brytescore( "realestate.searchedListings", { "search": search } );

subscribedSearch

A user subscribed to email alerts when updates to a search become available.

See also: unsubscribedSearch

Parameter Type Required Description
email email yes The email address where the user will receive updates
frequency string no How frequently the user will receive updates
search search yes The search for which the user will receive updates
/* subscribedSearch example */

var data = {
	"email": "mscott@dundermifflin.com",
	"frequency": "weekly",
	"search": search
};

brytescore( "realestate.subscribedSearch", data );

unsubscribedSearch

A user unsubscribed from updates for a particular search.

See also: subscribedSearch

Parameter Type Required Description
search search yes The search from which the user was unsubscribed
/* unsubscribedSearch example */

brytescore( "realestate.unsubscribedSearch", { "search": search } );

updatedSavedSearch

A user updated the criteria for a saved search.

See also: savedSearch

Parameter Type Required Description
search search yes The updated saved search
/* updatedSavedSearch example */

brytescore( "realestate.updatedSavedSearch", { "search": search } );

viewedSavedSearch

A user executed a saved search.

See also: savedSearch

Parameter Type Required Description
search search yes The saved search that was executed
/* viewedSavedSearch example */

brytescore( "realestate.viewedSavedSearch", { "search": search } );

Miscellaneous Real Estate Events

These events are not related to real estate searches or listings, but are common user action on real estate websites.

calculatedMortgagePayment

The user calculated a mortgage payment via an online calculator.

Parameter Type Required Description
downPayment number no The buyer's down payment amount
listing listing no The listing the user was viewing when the calculation was performed
payment number no The buyer's calculated (or preferred) monthly payment
price number no The amount to be financed
rate number no The interest rate
term number no The number of months in the loan
/* calculatedMortgagePayment example */

var data = {
	"downPayment": 40000,
	"listing": listing,
	"price": 200000,
	"rate": 5.25,
	"term": 360
};

brytescore( "realestate.calculatedMortgagePayment", data );

calculatedPropertyValuation

The user ran an automated property valuation.

Parameter Type Required Description
address address yes The address of the property the valuation was given for
value number no The properties valuation
valueRangeLow number no The minimum range of the valuation
valueRangeHigh number no The maximum range of the valuation
zestimate number no The zestimate valuation
valuationURL URL no The url of the property valuation report
valuationModel string no The model used to provide the valuation
/* calculatedPropertyValuation example */

var data = {
	"address": address,
	"value": 284000,
	"valueRangeLow": 213000,
	"valueRangeHigh": 295000,
	"zestimate": 310000,
	"valuationURL": "www.MyUrl/propertyValuation/742_Evergreen_Terrace",
	"valuationModel": "RealAVM"
};

brytescore( "realestate.calculatedPropertyValuation", data );

playedNeighborhoodVideo

The user played a video about a neighborhood.

Parameter Type Required Description
listing listing no The listing to which this video is related.
videoUrl uri no The URL of the video
neighborhood neighborhood yes The neighborhood the video is about
/* playedNeighborhoodVideo example */

var data = {
	"listing": listing,
	"videoUrl": "https://www.youtube.com/watch?v=GCdwKhTtNNw",
	"neighborhood": neighborhood
};

brytescore( "realestate.playedNeighborhoodVideo", data );

requestedCMA

A user requested a comparative market analysis on his/her home.

Parameter Type Required Description
address address yes The address of the property the user wants a CMA for
form realEstateForm yes The form data submitted by the user
/* requestedCMA example */

var data = {
	"address": address,
	"form": form
};

brytescore( "realestate.requestedCMA", data );

requestedHomeAppraisal

A user requested an appraisal on his/her home.

Parameter Type Required Description
address address yes The address of the property the user wishes appraised
form realEstateForm yes The form data submitted by the user
/* requestedHomeAppraisal example */

var data = {
	"address": address,
	"form": form
};

brytescore( "realestate.requestedHomeAppraisal", data );

searchedAgents

A user search for a real estate agent on the website.

See also: searchedOffices

Parameter Type Required Description
expertise string no The user is looking for agents with this area of expertise
language string no The user is looking for agents who speak this language
officeName string no The user is looking for agents domiciled in this office
searchURL uri no The URL of the user's agent search results
serviceArea string no The user is looking for agents in this service area
/* searchedAgents example */

var data = {
	"language": "Klingon",
	"serviceArea": "Kronos"
};

brytescore( "realestate.searchedAgents", data );

searchedOffices

A user search for a real estate office on the website.

See also: searchedAgents

Parameter Type Required Description
officeName string no The user is searching for offices with this name
serviceArea string no The user is looking for offices in this service area
/* searchedOffices example */

var data = {
	"serviceArea": "Kronos"
}

brytescore( "realestate.searchedOffices", data );

submittedAgentContactForm

A user submitted a contact form to a specific agent.

Parameter Type Required Description
agentId string/number no Your internal ID for this agent
form realEstateForm yes The form data submitted by the user
/* submittedAgentContactForm example */

var data = {
	"agentId": "721",
	"form": form
};

brytescore( "realestate.submittedAgentContactForm", data );

viewedAgentProfile

A user viewed the online profile of an agent.

Parameter Type Required Description
agentId string/number no Your internal ID for this agent
email email no The email address of the agent
/* viewedAgentProfile example */

var data = {
	"agentID": 2517,
	"email": "jules.winnfield@righteous-ezekiel.net"
};

brytescore( "realestate.viewedAgentProfile", data );

viewedDriveTime

The user viewed the drive time from one address to another.

See also: viewedDrivingDirections, printedDrivingDirections

Parameter Type Required Description
listing listing no The listing to which this drive time is related.
address1 address yes The first address, usually the listing's address.
address2 address yes The second address, usually a work or point of interest address.
timeOfDay string no The time of day selected by the user for the drive time.
address1ToAddress2Time number no The number of minutes to travel from address1 to address2.
address2ToAddress1Time number no The number of minutes to travel from address2 to address1.
/* viewedDriveTime example */

var data = {
	"listing": listing,
	"address1": address,
	"address2": address,
	"timeOfDay": "09:30am",
	"address1ToAddress2Time": 37,
	"address2ToAddress1Time": 17
};

brytescore( "realestate.viewedDriveTime", data );

viewedNeighborhoodProfile

The user viewed a profile of a neighborhood.

See also: viewedSubdivisionProfile, neighborhood

Parameter Type Required Description
listing listing no The listing the user was on when the neighborhood profile was viewed
neighborhood neighborhood yes The details for the viewed neighborhood
/* viewedNeighborhoodProfile example */

var data = {
	"listing": listing,
	"neighborhood": neighborhood
};

brytescore( "realestate.viewedNeighborhoodProfile", data );

viewedOfficeProfile

A user viewed the profile page for a brokerage office.

Parameter Type Required Description
address address no The address of the office
officeId string no Your internal ID for this office
officeName string no The name of the office
/* viewedOfficeProfile example */

var data = {
	"officeName": "Initech Corporate"
};

brytescore( "realestate.viewedOfficeProfile", data );

viewedSubdivisionProfile

A user viewed the profile of a subdivision.

See also: viewedNeighborhoodProfile, subdivision

Parameter Type Required Description
listing listing no The listing to which this subdivision is related
name string yes The name of the subdivision
/* viewedSubdivision example */

var data = {
	"listing": listing,
	"name": "Wilmington Park"
};

brytescore( "realestate.viewedSubdivisionProfile", data );

viewedSchoolProfile

A user viewed the profile of a school.

Parameter Type Required Description
listing listing no The listing to which this school is related.
name string yes The name of the school.
address address no The address of the school.
isElementarySchool boolean no This is an elementary school.
isMiddleSchool boolean no This is a middle school.
isHighSchool boolean no This is a high school.
/* viewedSchoolProfile example */

var data = {
	"listing": listing,
	"name": "Welton Academy for Boys",
	"isHighSchool": true
};

brytescore( "realestate.viewedSchoolProfile", data );
Copyright © 2018 Brytecore, Inc.Privacy PolicyTerms