This API produces a json array. Use it to retrieve a list of sessions. You can use this URL to perform GET or POST requests. Sessions can also be retrieved based on a visit_id, and/ or a machine_idx by using the Sessions_by_userapi call
One of the following parameters are required:
session_id
Display data for this session_id.
Session id is a unique identifier of each visit. Default is all session_ids.
date
Display all visits from the specified date entered as yyyy-MM-dd. Default is no date, and recent sessions.
period
The time-range considered for displaying the visits with respect to the date. For example: 3d for 3 days offset. Default is [1d].
limit
The minimum number of records to be displayed in the output. Default is [40]. Maximum is 1,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]. You can also use a comma separated list for your account to merge data, for example 'www.opentracker.net, www.opentracker.de'.
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.
timeZone
The time zone used. Use this option if more than one time zone is being recorded, by default the site's defined time zone is used. default is EST
dataType
The dataType parameter determines the format of the data returned. Values can be [json] | html | jsondatatable
dateFormat
The dateFormat parameter determines the format of dates returned. An example is dateFormat=yyyy-dd-MM. The syntax can be found here.
nextToken
nextToken = timestampday.timestamphouroffset (only available in jsondatatable format)
includeCountryCode
Display visits with the specified list of country codes. A list of country codes can be found here.
excludeInUrl
Display visits which do not have the specified words in the url.
excludeInFilteredCompany
Display visits which do not have the specified words in the company.
maxEventThreshold
Display visits which have the total event count (total_pages_viewed) below the specified number.
maxDuration
Display visits which have the session duration (duration_seconds) below the specified number.
removeIsp
On true, the isp exclusion is done. [false]|true
metaCsv
On true (default), the meta-data is shown (first few lines of a csv download). The meta-data shown are the site (account), the start date, the end date and the title and can be assigned as parameters to this api call.
unknownCity
All unknown cities will be replaced by an the specified string.
unknownRegion
All unknown regions will be replaced by an the specified string.
mapEuToCountryDomain
On true, all countries and countryCodes which were previously named as "Europe" and "EU" will be replaced by the country depending on the ccTLD of the site. Click here for more information on TLDs. [false]|true
gbCountryCode
The country_code column will also be modified to show the specified string instead of "GB". Works only for United Kingdom.
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. If you put in a column that does not exist this will throw an error.
filterByCurrentTitle
Filter out the data so that the result only contain the specified current title. current title is case sensitive.
orderCriteria
Sort data based on the criteria specified.
search
Find all visits with specified words. wildcard is supported in words. Default is [].
useOr
The operator applied to the search words. Default is [and].
Note:
a new column filtered_company is added if one of the following is defined: excludeInFilteredCompany, includeCountryCode, excludeInUrl, or maxEventThreshold. filtered_company is a column that best matches the company visiting. Please contact us for exact documentation.
To download all visits on 2012-10-10 to the website www.opentracker.net for the user "support@opentracker.net" with password "xxxxxx" without the metaCsv :
HTTP GET/ POST: c_view_session.jsp?login=demo@opentracker.net&password=demo123&site=www.opentracker.net&dataType=csv&metaCsv=false
This last example returns a json array with 'n' entries formatted as:
{"rows": 40, "field": ["lastEvent", "duration", "status", "flag", "country", "visits_pageviews", "currentPage", "area", "area_code", "browser", "browser_version", "city", "company_org", "connection", "country_code", "country_name", "currentTitle", "currentVisitDuration", "dma_code", "email", "entryPage", "entry_query", "entry_root_url", "entry_title", "eventUnixTimestamp", "event_id", "exit_query_id", "exit_root_url", "exit_title", "firstMeasurement", "first_session_unix_timestamp", "inet_aton", "ip_number", "isp", "isp_org", "latitude", "longitude", "machine_id", "machine_idx", "number_of_pages_viewed", "number_visits", "pages_viewed", "platform", "postal_code", "provider", "referrer", "referrersLogo", "region", "region_code", "resolution", "rnd", "search", "session_end_unix_timestamp", "session_id", "session_referrer", "session_referrer_hostname", "session_referrer_unix_timestamp", "session_search", "session_start_unix_timestamp", "site", "timezone", "total_duration", "total_number_visits", "total_pages_viewed", "type", "use_id", "user_status", "visit_id", "zipCode"], "label": ["last event", "duration", "status", "flag", "country", "visits(pv)", "current page (exit page)", "area code (tel)", "area_code", "browser", "browser_version", "city", "company/ org", "connection", "country_code", "country_name", "currentTitle", "current visit duration", "dma_code", "email", "entry page (landing page)", "entry_query", "entry_root_url", "entry title", "eventUnixTimestamp", "event_id", "exit_query_id", "exit_root_url", "exit title", "first measurement", "first_session_unix_timestamp", "inet_aton", "IP address", "isp", "isp/ org", "latitude", "longitude", "machine_id", "machine_idx", "pages viewed during visits (avg.)", "number of visits", "pageviews", "operating systems", "postal_code", "provider", "referrer", "referrersLogo", "region", "region_code", "resolution", "rnd", "search term", "session_end_unix_timestamp", "session_id", "session_referrer", "session_referrer_hostname", "session_referrer_unix_timestamp", "session_search", "session_start_unix_timestamp", "site", "timezone", "total duration", "total_number_visits", "total pages viewed", "type", "use_id", "status", "visit_id", "zip code"], "className": ["lastEvent", "duration", "status", "flag", "country", "visits_pageviews", "currentPage", "area", "area_code", "browser", "browser_version", "city", "company_org", "connection", "country_code", "country_name", "currentTitle", "currentVisitDuration", "dma_code", "email", "entryPage", "entry_query", "entry_root_url", "entry_title", "eventUnixTimestamp", "event_id", "exit_query_id", "exit_root_url", "exit_title", "firstMeasurement", "first_session_unix_timestamp", "inet_aton", "ip_number", "isp", "isp_org", "latitude", "longitude", "machine_id", "machine_idx", "number_of_pages_viewed", "number_visits", "pages_viewed", "platform", "postal_code", "provider", "referrer", "referrersLogo", "region", "region_code", "resolution", "rnd", "search", "session_end_unix_timestamp", "session_id", "session_referrer", "session_referrer_hostname", "session_referrer_unix_timestamp", "session_search", "session_start_unix_timestamp", "site", "timezone", "total_duration", "total_number_visits", "total_pages_viewed", "type", "use_id", "user_status", "visit_id", "zipCode"], "width": ["lastEvent", "duration", "status", "flag", "country", "visits_pageviews", "currentPage", "area", "area_code", "browser", "browser_version", "city", "company_org", "connection", "country_code", "country_name", "currentTitle", "currentVisitDuration", "dma_code", "email", "entryPage", "entry_query", "entry_root_url", "entry_title", "eventUnixTimestamp", "event_id", "exit_query_id", "exit_root_url", "exit_title", "firstMeasurement", "first_session_unix_timestamp", "inet_aton", "ip_number", "isp", "isp_org", "latitude", "longitude", "machine_id", "machine_idx", "number_of_pages_viewed", "number_visits", "pages_viewed", "platform", "postal_code", "provider", "referrer", "referrersLogo", "region", "region_code", "resolution", "rnd", "search", "session_end_unix_timestamp", "session_id", "session_referrer", "session_referrer_hostname", "session_referrer_unix_timestamp", "session_search", "session_start_unix_timestamp", "site", "timezone", "total_duration", "total_number_visits", "total_pages_viewed", "type", "use_id", "user_status", "visit_id", "zipCode"], "caption": "No caption", "pager": "apager", "nextToken": "1321401600000.1321466400000", "hidden": ["first_session_unix_timestamp", "timezone", "longitude", "latitude", "visit_id","machine_idx","total_pages_viewed", "countryName", "region", "city", "isp", "company_org", "isp_org", "provider", "referrersLogo", "referrer", "user_status", "number_visits", "pages_viewed", "currentTitle", "total_duration", "firstMeasurement", "platform", "browser", "resolution", "ip_number", "area","zipCode", "search", "lastVisitDuration", "currentVisitDuration", "endUnixTimestamp", "video", "download", "print", "country", "area_code", "browser_version","countr", "country_code", "country_name", "dma_code", "email","entry_query", "entry_root_url", "entry_title", "eventUnixTimestamp","event_id", "exit_query_id", "exit_root_url", "exit_title", "inet_aton", "last_speed", "machine_id", "number_of_pages_viewed", "otpe", "postal_code", "region_code", "rnd", "session_end_unix_timestamp", "session_id", "session_referrer", "session_referrer_hostname", "session_referrer_unix_timestamp", "session_search", "session_start_unix_timestamp", "site", "total_number_visits", "type", "use_id", "entryPage","debug", "session_referrer_unix_timestamp", "session_start_unix_timestamp", "session_end_unix_timestamp", "last_speed", "first_session_unix_timestamp", "region_code", "country_code"], "expandable": true, "popUpColumns":[["country", "countryName", "city", "region", "email", "video", "download", "print", "isp", "company_org", "isp_org", "provider", "area", "zipCode", "referrersLogo", "referrer","search", "user_status", "number_visits", "pages_viewed", "total_pages_viewed", "lastVisitDuration", "currentVisitDuration", "total_duration", "firstMeasurement", "platform", "browser", "resolution", "ip_number"],["currentPage", "currentTitle"]], "graph":[], "searchFields": [], "mergeUrl": [["currentPage", "currentTitle" ]], "merge":[], "profileColumns":["country", "countryName", "city", "region", "email", "video", "download", "print", "isp", "company_org", "isp_org", "provider", "visit_id", "area", "zipCode", "user_status", "number_visits", "pages_viewed", "total_pages_viewed", "lastVisitDuration", "currentVisitDuration", "total_duration", "firstMeasurement", "referrersLogo", "referrer","search", "platform", "browser", "resolution", "ip_number"], "expandUrl":"http://api.opentracker.net/api/visitors-online-email/cassandraPageViews.jsp?jsoncallback=?", "expand":[["filterByVisitId","", "", 1 ]], "expandDataIndex":[3, 4, 6], "equivalentColumns":[[6, "currentTitle"]], "rowsPerPageOptions": [ 20,40 ], "resultsList": [[ "Nov 17 12:44 AM", "20s", "puppet_online", "es", "Spain", "16 (2)", "http:\/\/www.opentracker.net\/loginpage", "", "", "Chrome 15.0.874.120", "15.0.874.120", "Vitoria", "", "Cable\/DSL", "ES", "Spain", "Get in here. | Opentracker.net", "20s", "", "", "http:\/\/www.opentracker.net", "", "http:\/\/www.opentracker.net", "Opentracker.net | Real-time Website Visitor Tracking, Traffic Monitoring, Statistics & Analysis", "1321472680399", "1321472679961.715589607", "", "http:\/\/www.opentracker.net\/loginpage", "Get in here. | Opentracker.net", "Oct 02 04:38 PM", "1317551937002", "1344183692", "80.30.157.140", "", "Telefonica De Espana", "42.850006", "-2.6667023", "10.245.194.182:1317844259538", "1317551937002.715589607", "2", "16", "2", "Windows 7", "", "", "", "", "Pais Vasco", "59", "1600 x 900", "82656", "", "1321472679961", "1321472676886.715589607", "", "", "", "", "1321472676886", "www.opentracker.net", "Europe\/Madrid", "", "16", "32", "session", "1317551937002.715589607", "online", "1321472676886.715589607", ""], [ "Nov 17 12:44 AM", "20h 44m 57s", "puppet_online", "us", "United States", "12 (1169)", "http:\/\/www.opentracker.net\/loginpage", "718", "718", "Firefox 8.0", "8.0", "Brooklyn", "", "", "US", "United States", "Get in here. | Opentracker.net", "20h 44m 57s", "501", "", "http:\/\/www.opentracker.net\/loginpage", "", "http:\/\/www.opentracker.net\/loginpage", "Get in here. | Opentracker.net", "1321472674158", "1321472673707.180515048", "", "http:\/\/www.opentracker.net\/loginpage", "Get in here. | Opentracker.net", "Oct 25 06:35 AM", "1319502921449", "412285522", "24.146.250.82", "", "Optimum Online", "40.633194", "-73.9967", "10.245.194.182:1319502921449", "1319502921449.180515048", "1169", "12", "1169", "Windows XP", "11219", "optonline.net", "http:\/\/ot2.opentracker.net\/login\/logout.jsp", "opentracker.net", "New York", "NY", "1920 x 1080", "80912", "", "1321472673707", "1321397999803.180515048", "http:\/\/ot2.opentracker.net\/login\/logout.jsp", "opentracker", "1321397999803", "", "1321397999803", "www.opentracker.net", "America\/New_York", "", "12", "22073", "session", "1319502921449.180515048", "online", "1321397999803.180515048", "11219"], [ "Nov 17 12:44 AM", "27s", "puppet_online", "gb", "United Kingdom", "1 (1)", "http:\/\/www.opentracker.net\/article\/hits-or-pageviews", "", "", "Firefox 8.0", "8.0", "Liverpool", "", "Cable\/DSL", "GB", "United Kingdom", "Hits or pageviews? | Opentracker.net", "27s", "", "", "http:\/\/www.opentracker.net\/article\/hits-or-pageviews", "", "http:\/\/www.opentracker.net\/article\/hits-or-pageviews", "Hits or pageviews? | Opentracker.net", "1321472671890", "1321472670088.47307255", "", "http:\/\/www.opentracker.net\/article\/hits-or-pageviews", "Hits or pageviews? | Opentracker.net", "Nov 17 12:44 AM", "1321472670088", "1452603543", "86.148.248.151", "", "British Telecommunications", "53.416702", "-3.0", "10.203.31.49:1321472670088", "1321472670088.47307255", "1", "1", "1", "Windows 7", "", "btcentralplus.com", "http:\/\/www.google.co.uk\/search?sa=t&rct=j&q=pageveiws&source=web&cd=2&ved=0CDYQFjAB&url=http%3A%2F%2Fwww.opentracker.net%2Farticle%2Fhits-or-pageviews&ei=lRLETuKYL4aa8QP_672GCw&usg=AFQjCNEcVhP1mL6SZjf2XcG2J6JnALxinw", "google.co.uk", "Liverpool", "H8", "1440 x 900", "82951", "pageveiws", "1321472670088", "1321472670088.47307255", "http:\/\/www.google.co.uk\/url?sa=t&rct=j&q=pageveiws&source=web&cd=2&ved=0CDYQFjAB&url=http%3A%2F%2Fwww.opentracker.net%2Farticle%2Fhits-or-pageviews&ei=lRLETuKYL4aa8QP_672GCw&usg=AFQjCNEcVhP1mL6SZjf2XcG2J6JnALxinw", "google", "1321472670088", "pageveiws", "1321472670088", "www.opentracker.net", "Europe\/London", "", "1", "1", "session", "1321472670088.47307255", "online", "1321472670088.47307255", ""], [ "Nov 17 12:44 AM", "3m 16s", "puppet_online", "us", "United States", "1 (6)", "http:\/\/www.opentracker.net\/resources\/video-screencasts", "484", "484", "IE 6.0", "6.0", "Ontario", "Kintiskton Llc", "Corporate", "US", "United States", "Video Screencasts | Opentracker.net", "3m 16s", "803", "", "http:\/\/www.opentracker.net\/company\/pressreleases\/amnesty-international-msf-and-red-cross-join-opentracker-philanthropy-program", "", "http:\/\/www.opentracker.net\/company\/pressreleases\/amnesty-international-msf-and-red-cross-join-opentracker-philanthropy-program", "amnesty international, MSf, and red cross join Opentracker philanthropy program | Opentracker.net", "1321472652132", "1321472651156.1331438727", "", "http:\/\/www.opentracker.net\/resources\/video-screencasts", "Video Screencasts | Opentracker.net", "Nov 17 12:41 AM", "1321472500789", "1064214070", "63.110.158.54", "Verizon Business", "", "34.0504", "-117.629395", "10.203.31.49:1321472500789",
â¦
"puppet_offline", "br", "Brazil", "1 (1)", "http:\/\/www.opentracker.net", "", "", "Firefox 8.0", "8.0", "Montes Claros", "", "", "BR", "Brazil", "Opentracker.net | Real-time Website Visitor Tracking, Traffic Monitoring, Statistics & Analysis", "s.e.", "", "", "http:\/\/www.opentracker.net", "", "http:\/\/www.opentracker.net", "Opentracker.net | Real-time Website Visitor Tracking, Traffic Monitoring, Statistics & Analysis", "1321470193682", "1321470191253.1333320398", "", "http:\/\/www.opentracker.net", "Opentracker.net | Real-time Website Visitor Tracking, Traffic Monitoring, Statistics & Analysis", "Nov 17 12:03 AM", "1321470191253", "3140228980", "187.44.23.116", "", "Rede Brasileira De Comunicacao Ltda", "-16.716705", "-43.8667", "10.203.31.49:1321470191253", "1321470191253.1333320398", "1", "1", "1", "Windows XP", "", "mastercabo.com.br", "http:\/\/www.google.com.br\/search?sa=t&rct=j&q=open%20tracker&source=web&cd=1&sqi=2&ved=0CBwQFjAA&url=http%3A%2F%2Fwww.opentracker.net%2F&ei=5gjETtLlH4W4tweB2pXpDQ&usg=AFQjCNF_sR92wQcPqCOEtaMSc0JR37MFfQ&cad=rja", "google.com.br", "Minas Gerais", "15", "1440 x 900", "98072", "open tracker", "1321470191253", "1321470191253.1333320398", "http:\/\/www.google.com.br\/url?sa=t&rct=j&q=open%20tracker&source=web&cd=1&sqi=2&ved=0CBwQFjAA&url=http%3A%2F%2Fwww.opentracker.net%2F&ei=5gjETtLlH4W4tweB2pXpDQ&usg=AFQjCNF_sR92wQcPqCOEtaMSc0JR37MFfQ&cad=rja", "google", "1321470191253", "open tracker", "1321470191253", "www.opentracker.net", "Brazil\/Acre", "", "1", "1", "session", "1321470191253.1333320398", "offline", "1321470191253.1333320398", ""], [ "Nov 17 12:02 AM", "s.e.", "puppet_offline", "it", "Italy", "200 (1)", "http:\/\/www.opentracker.net\/loginpage", "", "", "Firefox 3.6.24", "3.6.24", "Cicciano", "", "Cable\/DSL", "IT", "Italy", "Get in here. | Opentracker.net", "s.e.", "", "", "http:\/\/www.opentracker.net\/loginpage", "", "http:\/\/www.opentracker.net\/loginpage", "Get in here. | Opentracker.net", "1321470178241", "1321470177785.845067526", "", "http:\/\/www.opentracker.net\/loginpage", "Get in here. | Opentracker.net", "Jun 21 12:36 PM", "1308638204192", "1326880990", "79.22.152.222", "", "Telecom Italia", "40.966705", "14.533295", "10.243.94.86:1308638204192", "1308638204192.845067526", "1", "200", "1", "Windows 7", "", "telecomitalia.it", "http:\/\/www.allwebcreative.co.uk\/home.html", "allwebcreative.co.uk", "Campania", "04", "1680 x 1050", "75717", "", "1321470177785", "1321470177785.845067526", "http:\/\/www.allwebcreative.co.uk\/home.html", "allwebcreative", "1321470177785", "", "1321470177785", "www.opentracker.net", "Europe\/Rome", "", "200", "211", "session", "1308638204192.845067526", "offline", "1321470177785.845067526", ""], [ "Nov 17 12:02 AM", "4m 14s", "puppet_offline", "us", "United States", "1 (4)", "http:\/\/www.opentracker.net\/features", "919", "919", "Safari 5.1.1", "5.1.1", "Raleigh", "Webfargo Data Security", "Corporate", "US", "United States", "Get More | Opentracker.net", "4m 14s", "560", "", "http:\/\/www.opentracker.net", "", "http:\/\/www.opentracker.net", "Opentracker.net | Real-time Website Visitor Tracking, Traffic Monitoring, Statistics & Analysis", "1321470129646", "1321470128676.1405725785", "", "http:\/\/www.opentracker.net\/features", "Get More | Opentracker.net", "Nov 16 11:57 PM", "1321469874447", "1107344354", "66.0.187.226", "Itc Deltacom", "", "35.887405", "-78.751", "10.203.31.49:1321469874447", "1321469874447.1405725785", "4", "1", "4", "Intel Mac OS X 10.6.8", "27617", "", "http:\/\/www.google.com\/search?sa=t&rct=j&q=track%20user%20on%20website&source=web&cd=1&ved=0CEQQFjAA&url=http%3A%2F%2Fwww.opentracker.net%2F&ei=qgfETsOCLI7rtgfYgKGODg&usg=AFQjCNF_sR92wQcPqCOEtaMSc0JR37MFfQ", "google.com", "North Carolina", "NC", "1344 x 840", "29006", "track user on website", "1321470128676", "1321469874447.1405725785", "http:\/\/www.google.com\/url?sa=t&rct=j&q=track%20user%20on%20website&source=web&cd=1&ved=0CEQQFjAA&url=http%3A%2F%2Fwww.opentracker.net%2F&ei=qgfETsOCLI7rtgfYgKGODg&usg=AFQjCNF_sR92wQcPqCOEtaMSc0JR37MFfQ", "google", "1321469874447", "track user on website", "1321469874447", "www.opentracker.net", "America\/New_York", "", "1", "4", "session", "1321469874447.1405725785", "offline", "1321469874447.1405725785", "27617"], [ "Nov 17 12:00 AM", "s.e.", "puppet_offline", "ca", "Canada", "1 (1)", "http:\/\/www.opentracker.net\/article\/clickstream-or-clickpath-analysis", "", "", "IE 9.0", "9.0", "Nanaimo", "", "Cable\/DSL", "CA", "Canada", "Clickstream or clickpath analysis | Opentracker.net", "s.e.", "", "", "http:\/\/www.opentracker.net\/article\/clickstream-or-clickpath-analysis", "", "http:\/\/www.opentracker.net\/article\/clickstream-or-clickpath-analysis", "Clickstream or clickpath analysis | Opentracker.net", "1321470038280", "1321470037909.96734620", "", "http:\/\/www.opentracker.net\/article\/clickstream-or-clickpath-analysis", "Clickstream or clickpath analysis | Opentracker.net", "Nov 17 12:00 AM", "1321470037909", "1178800651", "70.67.18.11", "", "Shaw Communications", "49.149994", "-123.9167", "10.203.31.49:1321470037909", "1321470037909.96734620", "1", "1", "1", "Windows 7", "", "shawcable.net", "http:\/\/www.google.ca\/search?sa=t&rct=j&q=metrics%20for%20following%20clickpath&source=web&cd=4&ved=0CDYQFjAD&url=http%3A%2F%2Fwww.opentracker.net%2Farticle%2Fclickstream-or-clickpath-analysis&ei=SgjETsmeK6OTiAL-5NSGDA&usg=AFQjCNFwte4K1Zyy6k30qtojKYpsjf83Mw&sig2=Za--qJvG4APlBc4NjRn_Ng", "google.ca", "British Columbia", "BC", "1441 x 810", "35187", "metrics for following clickpath", "1321470037909", "1321470037909.96734620", "http:\/\/www.google.ca\/url?sa=t&rct=j&q=metrics%20for%20following%20clickpath&source=web&cd=4&ved=0CDYQFjAD&url=http%3A%2F%2Fwww.opentracker.net%2Farticle%2Fclickstream-or-clickpath-analysis&ei=SgjETsmeK6OTiAL-5NSGDA&usg=AFQjCNFwte4K1Zyy6k30qtojKYpsjf83Mw&sig2=Za--qJvG4APlBc4NjRn_Ng", "google", "1321470037909", "metrics for following clickpath", "1321470037909", "www.opentracker.net", "America\/Vancouver", "", "1", "1", "session", "1321470037909.96734620", "offline", "1321470037909.96734620", ""] ] }
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