Referred visits

Display all referred visits. This specific api call is turned off by default, please contact to turn this api call on.

API Usage

This API produces a json array. Perform GET or POST requests. Visits can also be retrieved based on a visit_id, and/ or a machine_idx.


One or more of the following parameters are required:

filterByReferrer: Display data for the specified referrer. Default is all referrers.
filterByMachineId Display data for these machine ids. Machine id is a unique identifier of each visitor. Default is all machine idx'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 The 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. Default is [40]. Maximum is 10,000.
login Your opentracker login email. Default is [].
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 [].
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 exmaple is dateFormat=yyyy-dd-MM. The syntax can be found here.


To search for all referred visits to
HTTP GET/ POST:view_visits_referrer.jsp?
To search for all visits where the first visit was referred by a user with the machine id 12:
HTTP GET/ POST: view_visits_referrer.jsp?filterByMachineId=1234567


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

				{ "resultsList": [


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