All

Writing data

• Docs
  • Inserting data [general]
    • Inserting event data
    • Users, sessions & events
    • Adding properties
    • Reserved properties
  • Opentracker Implementation
    • Javascript implementation
    • Tracking native iOS app events
    • Android app tracking
    • Inserting Raw Data with a url

Reading data

• Visits
  • classic
    • visits
    • visits first time
    • visits returning
    • visits referrer
    • visits searches
    • visits exit link
    • unique visitors
    • browsers
    • platform
    • source
    • goal
    • ip number
    • isp/ company / org.
    • pageviews
    • geo location
  • Next generation
    • sessions (nt)
    • sessions by user (nt)
    • event (nt)
• Trends
  • trends
  • hourly trends
  • pages
  • summary
• Top lists
  • pages
  • paths
  • referrers
  • search engines
  • search terms
  • entry pages
  • exit pages
  • exit links
  • properties
• Technical data
  • OS/ platform
  • browsers
  • display color
  • display resolutions
  • routers
  • domains
• Geo-location data
  • companies
  • isps
  • country /region /city
  • continent
  • sub-continent
  • postal codes
  • area codes
• Management
  • find user
  • add user
  • find server
  • find server (xml)
  • Get timezone for site
  • check if site exists
  • generate ticketId
  • is valid ticket?

Visits

All visits (sessions) to a site

API Usage

This API produces a json array. Use it to retrieve visits. You can 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 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_idx's.
filterByVisitId Display data for these visit_ids. Visit id is a unique identifier of each visit. Default is all visit_ids.
showColumns Display only the columns specified in this parameter. The columns are input as a comma separated list. Only the raw technical column names are recognized. Click here to see the list. By default, all columns are shown.
hideColumns Does not display the columns specified in this parameter. The columns are input as a comma separated list. Only the raw technical column names are recognized. Click here to see the list. If both showColumns and hideColumns are specified, showColumns will override hideColumns. By default, all columns are shown.
date Display all visits from the specified date entered as yyyy-MM-dd. Default is the current date.
period The time-range considered for displaying the visits with respect to the date. For example: 3d for 3 days offset. Default is [1d].
offset The starting point from where records will display. Default is [0] (most recent chronological event).
limit The maximum number of records to be displayed in the output. Default is [40]. Maximum is 10,000.
login Your opentracker login email. Default is [demo@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. Default is [demo123].
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. Default is [en_US]. A list of locales can be found here.
ignoreLocale Display columns without language translation. Boolean. [false]|true.
timeZone The timezone to view the visits in. Default is the site's defined timezone.
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.

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

---