Getting Started

Choose your language

Before you get started, select the appropriate language at the top of this page. Choose JavaScript for instructions on using the client-side web library, iOS to use our Swift library, or Android to use our Java library.

If you want to implement Brytelytics server-side on your PHP, ASP.Net, Node, or other server, choose the HTTP option.

Your code will send activity events via HTTP POSTs to the API server. To avoid any potential bottlenecks, the server will only return 200 OK responses when a POST is successfully received. To see if your events are validating and logging correctly, make sure to visit the Developer Dashboard.

Implementation Methods

You can install Brytelytics in your iOS or Android app via client-side tracking libraries. If you are installing Brytelytics in a website, you can choose between a JavaScript client-side library or web server-side tracking.

Client-Side Tracking

Brytecore has provided official libraries for iOS, Android and JavaScript client-side tracking. You can read these instructions in the Client-Side Tracking guide.

Server-Side Tracking

For websites, we recommend server-side tracking assisted by the client-side Brytelytics snippet, as it lowers dependency on browsers and asynchronicity issues with web forms. You can read these instructions in the Server-Side Tracking guide.

Hook Up Registrations and Logins

When a user registers with your app or web site, you should log the action with the registeredAccount event. When a registered user logs into your app or 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.

Don't forget to authenticate a user when they log in via cookie or remembered session! If you have a "Remember Me" feature, it should trigger authenticate on session start.

1/* Example user registration event. */
2
3// Create an object to store the user data you wish to track.
4var data = {
5	"userAccount" : {
6		"id": "123456",
7		"email": "revenge@florin.com",
8		"firstName": "Inigo",
9		"lastName": "Montoya"
10	},
11	"isLead": true
12};
13
14// Call the registered event
15brytescore("registeredAccount", data);

Log Real Estate Events

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 Brytelytics algorithms will be. Brytelytics supports a large variety of real estate and normal events, as listed in Real Estate Objects and Events.

As a general rule, if your app or web site has a feature related to real estate, you should be tracking it with Brytelytics. If you're looking for some guidance for prioritizing these tracked events, see the next section, Which Events Should You Track?.

1/* Example listing view event. */
2
3// Create an object to store the data you wish to track.
4var data = {
5	"listing": {
6		"price": 349000,
7		"mlsId": "2983599",
8		"address": {
9			"streetAddress": "196 Humperdink Lane",
10			"city": "Florin City",
11			"stateProvince": "Florin",
12			"postalCode": "00990"
13		},
14		"geoLocation": {
15			"latitude": "33.859821",
16			"longitude": "-84.168221"
17		},
18		"photoURL": "http://images.yoursite.com/2983599_1.jpg",
19		"listingURL": "http://www.yoursite.com/listings/2983599/",
20		"fullBaths": 3,
21		"halfBaths": 1,
22		"bedrooms": 4,
23		"subdivision": "Buttercup Rise",
24		"features": [
25			"Master on main",
26			"Hardwood floors",
27			"Fireplace",
28			"Level lot",
29			"Deck/Patio",
30			"Fenced yard",
31			"Garage: 3 car or more",
32			"Garage: attached"
33		]
34	}
35};
36
37// Call the viewed_listing event
38brytescore("realestate.viewedListing", data);