Returning visits

Display visits made by visitors who have been to website before (returning). This specific api call is turned off by default, please contact support@opentracker.net to turn this api call on.

API Usage

This API produces a json array. Use this URL to perform GET or POST requests. Visits can also be retrieved based on a visit_id, and/ or a machine_idx.

Parameters

One or more of the following parameters are required:
filterByMachineId Display data for these machine ids. Machine id is a unique identifier of each visitor. Default is all machine id's.
filterByVisitId Display data for these visit ids. Visit id is a unique identifier of each visit. Default is all visit ids.
from Find all visits from the specified unix timestamp. Default is all unix timestamps.
to Find all visits up to the specified unix timestamp. Default is all unix timestamps.
offset Starting point from which records will display. Default is [0] (most recent chronological event).
limit Maximum number of records to be displayed in the output. The default is [40]. The maximum is 10,000.
login Your opentracker login email. Default is [support@opentracker.net].
password Your password.
ticketId A ticketId can be used to provide credentials with an expiring token. A ticketId can be used instead of a login/ password combination. Further information can be found here.
site The site for which to display data. Default is [www.opentracker.net].
locale The locale parameter is an identifier for a particular combination of language and region (e.g. en_US) and determines the format of the data returned. A list of locales can be found here.
ignoreLocale Display columns without language translation. Boolean. [false]|true.
dataType The dataType parameter determines the format of the data returned. Values can be [json] | html | jsondatatable | jsonjqgrid
dateFormat The dateFormat parameter determines the format of dates returned. An example is dateFormat=yyyy-dd-MM. The syntax can be found here.

Examples

To search for all the returning visits for www.opentracker.net with firefox:
HTTP GET/ POST: view_visits_referrer.jsp?login=demo@opentracker.net&password=demo123&site=www.opentracker.net&offset=0&limit=10
To search for all returning visits with machine id 1487329:
HTTP GET/ POST: view_visits_referrer.jsp?filterByMachineId=1487329

Response

This page returns a json array with 'n' entries starting from the specified offset formatted as:

				  { "resultsList": [
{
"error":"no-data"}
]
}



				

Errors

If errors are encountered, the first encountered error will be returned of form "Error: exception: message

Error: java.lang.RuntimeException: Login/ site combination is not valid

We would love to hear your feedback. Please use the facebook comment box below