In order to collect user behavior data from your website, you first need to place a snippet of code into each of your pages. We'll immediately begin collecting general analytics data, such as page views and session lengths.
Copy and paste this code into your site header, inside the HEAD
section of each page. This can usually be performed inside a server-side include or
templating engine partial. Replace YOUR_API_KEY with your own key.
<!-- Brytescore -->
<script>
(function(a,c,g,e,d,f,b){e[d]=e[d] || function () {
(e[d].q = e[d].q || []).push( arguments )
};e[d].t=1*new Date();
b=a.getElementsByTagName( c )[0];f=a.createElement(c);f.async=1;f.src=g;b.parentNode.insertBefore(f,b)})
(document,"script","https://cdn.brytecore.com/brytescore.js/brytescore.min.js",window,"brytescore");
brytescore("setAPIKey","YOUR_API_KEY");
brytescore("pageView",{});
brytescore("load","https://cdn.brytecore.com/packages/realestate/package.json");
</script>
<!-- End Brytescore -->
When a user registers on your site, you should log the action with the
registeredAccount event. When a registered user logs into your site, you should use
the authenticated event. Remember to place these events wherever a user can
register or authenticate, such as login pages or popover windows.
Below is an example user registration event. See the Core Objects & Events for details on the userAccount object and registration event.
/* Example user registration event. */
// Create an object to store the user data you wish to track.
var data = {
"userAccount" : {
"id": "123456",
"email": "revenge@florin.com",
"firstName": "Inigo",
"lastName": "Montoya"
},
"isLead": true
};
// Call the registered event
brytescore("registeredAccount", data);
As a user performs activities on your site, you should track them with the brytescore
function. The more activities you track, the more accurate the Lead Booster algorithms will be.
Lead Booster supports a large variety of real estate and normal events, as listed in
Core Objects & Events and
Real Estate Package.
Below is an example of a viewedListing real estate event. When the user is shown
the details of a listing, the website tracks many details about the listing, in addition
to the event itself.
/* Example listing view event. */
// Create an object to store the data you wish to track.
var data = {
"listing": {
"price": 349000,
"mlsId": "2983599",
"address": {
"streetAddress": "196 Humperdink Lane",
"city": "Florin City",
"stateProvince": "Florin",
"postalCode": "00990"
},
"geoLocation": {
"latitude": "33.859821",
"longitude": "-84.168221"
},
"photoURL": "http://images.yoursite.com/2983599_1.jpg",
"listingURL": "http://www.yoursite.com/listings/2983599/",
"fullBaths": 3,
"halfBaths": 1,
"bedrooms": 4,
"subdivision": "Buttercup Rise",
"features": [
"Master on main",
"Hardwood floors",
"Fireplace",
"Level lot",
"Deck/Patio",
"Fenced yard",
"Garage: 3 car or more",
"Garage: attached"
]
}
};
// Call the viewed_listing event
brytescore("realestate.viewedListing", data);
Generally, you should track every event that your website or system supports. Your analytics dashboards and user profiles will be more accurate and interesting if you track all of your events.
Events can be used for one or more of the following purposes inside the Lead Booster products:
The table below should help you prioritize which events should be tracked by your system. If your system does not have an event marked as required, please contact us for support.
Many events expect an object as one of the parameters. Similar to event tracking, you should track every property on objects that your system supports. This section should help you prioritize which object parameters you should provide.
address object)["master on main", "fireplace", "level lot"])geo object)null if unavailable)33.859821)-84.168221)Note these are parameters passed by the user when performing a search. As such, none are required, because the user may not pass any parameters at all, or only a few. Send us what the user searches for.
address object, ex: {"state":"RI"} when searching only for properties in Rhode Island)["Cape Cod", "Boston"])["Barnstable"])["Beach", "1 Car Garage", "Bungalow"])["1118198"])["02840", "02891"])Note that these fields will vary by form - send what you have.
telephone object)listing object)Note that this can include more than one number, but only one number of each type.
That's the end of the Quick Start guide. For more in depth discussion of the Lead Booster Analytics API, begin at the Lead Booster API Overview.