Skip to content
Garrett Roach edited this page Aug 25, 2016 · 1 revision

API URL http://api.webstreak.com/api/website/customers

Note API keys are unique by website/domain

Activity Stream

Return user activity on website by email or phone number

Params: api_key(required), phone and/or email

GET /activity_stream?api_key=apikey&[email protected]&phone=123456789

Response example:
[  
   [  
      [  
         "August 23, 2016",
         [  
            [  
               {  
                  "table":{  
                     "time":"07:52 pm",
                     "date":"August 23, 2016",
                     "uniq_index":"0-397b4495-4368-46c0-ad12-97d3685256ad",
                     "event":"Visted Site",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":null,
                     "model":null,
                     "inventory_type":null,
                     "year":null,
                     "stock_number":null,
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               }
            ],
            [  
               {  
                  "table":{  
                     "time":"07:53 pm",
                     "date":"August 23, 2016",
                     "uniq_index":"1-397b4495-4368-46c0-ad12-97d3685256ad",
                     "event":"Form Submission",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":null,
                     "model":null,
                     "inventory_type":null,
                     "year":null,
                     "stock_number":null,
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               }
            ],
            [  
               {  
                  "table":{  
                     "time":"08:00 pm",
                     "date":"August 23, 2016",
                     "uniq_index":"2-397b4495-4368-46c0-ad12-97d3685256ad",
                     "event":"Search Results Page View",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles?query=new+corolla",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":null,
                     "model":null,
                     "inventory_type":null,
                     "year":null,
                     "stock_number":null,
                     "vehicles_found":"378",
                     "vin":null,
                     "form_title":null
                  }
               }
            ]
         ]
      ],
      [  
         "August 25, 2016",
         [  
            [  
               {  
                  "table":{  
                     "time":"01:47 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"3-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Visted Site",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":null,
                     "model":null,
                     "inventory_type":null,
                     "year":null,
                     "stock_number":null,
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               }
            ],
            [  
               {  
                  "table":{  
                     "time":"01:47 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"4-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Search Results Page View",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles?query=new+corolla",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":null,
                     "model":null,
                     "inventory_type":null,
                     "year":null,
                     "stock_number":null,
                     "vehicles_found":"373",
                     "vin":null,
                     "form_title":null
                  }
               },
               {  
                  "table":{  
                     "time":"01:48 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"5-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Search Results Page View",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles?query=new+corolla#",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":null,
                     "model":null,
                     "inventory_type":null,
                     "year":null,
                     "stock_number":null,
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               },
               {  
                  "table":{  
                     "time":"01:54 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"6-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Search Results Page View",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles?price=15000",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":null,
                     "model":null,
                     "inventory_type":null,
                     "year":null,
                     "stock_number":null,
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               }
            ],
            [  
               {  
                  "table":{  
                     "time":"01:56 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"7-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Form Start",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles?price=15000",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":"Toyota",
                     "model":"Corolla",
                     "inventory_type":"certified",
                     "year":"2011",
                     "stock_number":null,
                     "vehicles_found":null,
                     "vin":"2T1BU4EE0BC662243",
                     "form_title":"eprice"
                  }
               }
            ],
            [  
               {  
                  "table":{  
                     "time":"02:05 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"8-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Vehicle Detail Page View",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles/2007-toyota-camry-le-22292a-4t1be46k27u578867",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":"Toyota",
                     "model":"Camry",
                     "inventory_type":"certified",
                     "year":"2007",
                     "stock_number":"22292A",
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               },
               {  
                  "table":{  
                     "time":"02:05 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"9-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Vehicle Detail Page View",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles/2011-toyota-corolla-22351a-2t1bu4ee0bc662243",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":"Toyota",
                     "model":"Corolla",
                     "inventory_type":"certified",
                     "year":"2011",
                     "stock_number":"22351A",
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               },
               {  
                  "table":{  
                     "time":"02:06 pm",
                     "date":"August 25, 2016",
                     "uniq_index":"10-c92053f3-657c-4110-b211-a7e8eaa030a6",
                     "event":"Vehicle Detail Page View",
                     "browser":"Chrome",
                     "browser_version":52,
                     "city":"Apex",
                     "current_url":"https://www.domain.com/vehicles/2010-toyota-corolla-le-stk480764-2t1bu4ee7ac480764",
                     "initial_referrer":null,
                     "initial_referring_domain":"www.google.com",
                     "lib_version":"2.9.14",
                     "os":"Windows",
                     "region":"North Carolina",
                     "country":null,
                     "make":"Toyota",
                     "model":"Corolla",
                     "inventory_type":"certified",
                     "year":"2010",
                     "stock_number":"20806B",
                     "vehicles_found":null,
                     "vin":null,
                     "form_title":null
                  }
               }
            ]
         ]
      ]
   ]
]

Known Visitors Query

Return known visitors and their profile information for a given look back window (in seconds) - default is 86400.

Params: api_key(required), seconds(optional)

GET /activity_stream?api_key=apikey&seconds=60000

Response example (limit 1000 records):
{  
   "page":0,
   "page_size":1000,
   "results":[  
      {  
         "$distinct_id":"156b9d19d9f75-0d817ce107cb09-3c654009-100200-156b9d19da02e6",
         "$properties":{  
            "$browser":"Chrome",
            "$browser_version":52,
            "$city":"Apex",
            "$country_code":"US",
            "$email":"[email protected]",
            "$first_name":"First",
            "$initial_referrer":"https://www.google.com/",
            "$initial_referring_domain":"www.google.com",
            "$last_name":"Last",
            "$os":"Windows",
            "$predict_grade":"D",
            "$region":"North Carolina",
            "$timezone":"America/New_York",
            "Events":[  
               "{\"category\":\"Search Results Page View\",\"query\":\"new corolla\",\"vehiclesfound\":\"378\",\"timestamp\":\"Tue Aug 23 2016 19:59:48 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"],\"token\":\"2f2c9ef8c2e9dc7b36d84600a169086e\"}",
               "{\"category\":\"Search Results Page View\",\"query\":\"new corolla\",\"vehiclesfound\":\"373\",\"timestamp\":\"Thu Aug 25 2016 13:47:24 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"],\"token\":\"2f2c9ef8c2e9dc7b36d84600a169086e\"}",
               "{\"category\":\"Search Results Page View\",\"timestamp\":\"Thu Aug 25 2016 13:54:35 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"],\"token\":\"2f2c9ef8c2e9dc7b36d84600a169086e\"}",
               "{\"category\":\"Form Start\",\"color\":\"Magnetic Gray Metallic\",\"engine\":\"4\",\"eprice-text\":\"Get Your ePrice\",\"form_title\":\"eprice\",\"full_name\":\"2011 Toyota Corolla \",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"mileage\":\"136839\",\"model\":\"Corolla\",\"photo\":\"https",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Camry\",\"stock\":\"22292A\",\"year\":\"2007\",\"timestamp\":\"Thu Aug 25 2016 14:04:43 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"22351A\",\"year\":\"2011\",\"timestamp\":\"Thu Aug 25 2016 14:05:21 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"20806B\",\"year\":\"2010\",\"timestamp\":\"Thu Aug 25 2016 14:06:32 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Honda\",\"model\":\"Accord Sdn\",\"stock\":\"21015B\",\"year\":\"2011\",\"timestamp\":\"Thu Aug 25 2016 14:07:56 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"20647B\",\"year\":\"2013\",\"timestamp\":\"Thu Aug 25 2016 14:08:21 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"22108A\",\"year\":\"2012\",\"timestamp\":\"Thu Aug 25 2016 14:09:39 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Camry\",\"stock\":\"20180A\",\"year\":\"2013\",\"timestamp\":\"Thu Aug 25 2016 14:10:19 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}"
            ],
            "First Form Submission":"2016-08-23T19:53:09",
            "First Search Results Page View":"2016-08-23T19:59:48",
            "Form Submission count":1,
            "Forms Submitted":[  
               "coupon"
            ],
            "Last Form Submission":"2016-08-23T19:53:09",
            "Last Search Results Page View":"2016-08-25T13:54:35",
            "Last querys of interest":"new corolla",
            "Other Email Addresses":[  
               "[email protected]"
            ],
            "Other Names":[  
               "First Last"
            ],
            "Other Phone Numbers":[  
               "123456789"
            ],
            "Search Results Page View Events":[  
               "{\"category\":\"Search Results Page View\",\"query\":\"new corolla\",\"vehiclesfound\":\"378\",\"timestamp\":\"Tue Aug 23 2016 19:59:48 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Search Results Page View\",\"query\":\"new corolla\",\"vehiclesfound\":\"373\",\"timestamp\":\"Thu Aug 25 2016 13:47:24 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Search Results Page View\",\"timestamp\":\"Thu Aug 25 2016 13:54:35 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}"
            ],
            "Search Results Page View count":3,
            "client":"domain.com",
            "phone":"123456789",
            "querys of interest":[  
               "new corolla",
               "new corolla"
            ],
            "uuid":"397b4495-4368-46c0-ad12-97d3685256ad",
            "colors of interest":[  
               [  
                  "white"
               ],
               "Magnetic Gray Metallic"
            ],
            "Last colors of interest":"Magnetic Gray Metallic",
            "Form Start count":1,
            "Last Form Start":"2016-08-25T13:56:30",
            "Form Start Events":[  
               "{\"category\":\"Form Start\",\"color\":\"Magnetic Gray Metallic\",\"engine\":\"4\",\"eprice-text\":\"Get Your ePrice\",\"form_title\":\"eprice\",\"full_name\":\"2011 Toyota Corolla \",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"mileage\":\"136839\",\"model\":\"Corolla\",\"photo\":\"https"
            ],
            "First Form Start":"2016-08-25T13:56:30",
            "years of interest":[  
               2011,
               2007,
               2011,
               2010,
               2011,
               2013,
               2012,
               2013
            ],
            "Last years of interest":2013,
            "makes of interest":[  
               "Toyota",
               "Toyota",
               "Toyota",
               "Toyota",
               "Honda",
               "Toyota",
               "Toyota",
               "Toyota"
            ],
            "Last makes of interest":"Toyota",
            "models of interest":[  
               "Corolla",
               "Camry",
               "Corolla",
               "Corolla",
               "Accord Sdn",
               "Corolla",
               "Corolla",
               "Camry"
            ],
            "inventorytypes of interest":[  
               "certified",
               "certified",
               "certified",
               "certified",
               "certified",
               "certified",
               "certified",
               "certified"
            ],
            "Last models of interest":"Camry",
            "Last inventorytypes of interest":"certified",
            "Last Vehicle Detail Page View":"2016-08-25T14:10:19",
            "Last stocks of interest":"20180A",
            "First Vehicle Detail Page View":"2016-08-25T14:04:43",
            "Vehicle Detail Page View count":7,
            "stocks of interest":[  
               "22292A",
               "22351A",
               "20806B",
               "21015B",
               "20647B",
               "22108A",
               "20180A"
            ],
            "Vehicle Detail Page View Events":[  
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Camry\",\"stock\":\"22292A\",\"year\":\"2007\",\"timestamp\":\"Thu Aug 25 2016 14:04:43 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"22351A\",\"year\":\"2011\",\"timestamp\":\"Thu Aug 25 2016 14:05:21 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"20806B\",\"year\":\"2010\",\"timestamp\":\"Thu Aug 25 2016 14:06:32 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Honda\",\"model\":\"Accord Sdn\",\"stock\":\"21015B\",\"year\":\"2011\",\"timestamp\":\"Thu Aug 25 2016 14:07:56 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"20647B\",\"year\":\"2013\",\"timestamp\":\"Thu Aug 25 2016 14:08:21 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Corolla\",\"stock\":\"22108A\",\"year\":\"2012\",\"timestamp\":\"Thu Aug 25 2016 14:09:39 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}",
               "{\"category\":\"Vehicle Detail Page View\",\"inventorytype\":\"certified\",\"make\":\"Toyota\",\"model\":\"Camry\",\"stock\":\"20180A\",\"year\":\"2013\",\"timestamp\":\"Thu Aug 25 2016 14:10:19 GMT-0400 (Eastern Daylight Time)\",\"brands\":[\"Scion\",\"Toyota\"]}"
            ],
            "$last_seen":"2016-08-25T14:10:41"
         }
      }
   ],
   "session_id":"1472148917-RwlemO",
   "status":"ok",
   "total":1
}