Goal visits

Display which goal visitors have reached. 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. Visitors can also be retrieved based on the goal, and/ or a visit_id.

Parameters

One or more of the following parameters are required:

filterByGoal: Find all goal visits with specified goal name as a goal which has been reached by the visitor(s). Default is all goal names.
filterByMachineId Display data for these machine ids. Machine id is a unique identifier of each visitor. Default is all machine ids.
filterByVisitId Display data for these visit ids. Visit id is a unique identifier of each visit. Default is all visit ids.
from Find all goal visits from the specified unix timestamp. Default is all unix timestamps.
to Find all goal visits up to the specified unix timestamp. Default is all unix timestamps.
offset The starting point from where the records are to be displayed. 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 [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.
dataType The dataType parameter determines the format of the data returned. Values can be [json] | html | jsondatatable | jsonjqgrid
ignoreLocale Display columns without language translation. Boolean. [false]|true.
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 visits to www.opentracker.net with "trial.page3" as a goal:
HTTP GET/ POST: view_goal.jsp?login=demo@opentracker.net&password=demo123&site=www.opentracker.net&filterByGoal=trial.page3&offset=8&limit=2

Response

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

					{ "resultsList": [
{
"error":"java.lang.NullPointerException\\n\\tat org.apache.jsp.api.views.view_005fgoal_jsp._jspService(view_005fgoal_jsp.java:583)\\n\\tat org.apache.jasper.runtime.HttpJspBase.service(HttpJspBase.java:70)\\n\\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:717)\\n\\tat org.apache.jasper.servlet.JspServletWrapper.service(JspServletWrapper.java:377)\\n\\tat org.apache.jasper.servlet.JspServlet.serviceJspFile(JspServlet.java:313)\\n\\tat org.apache.jasper.servlet.JspServlet.service(JspServlet.java:260)\\n\\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:717)\\n\\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:290)\\n\\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)\\n\\tat org.tuckey.web.filters.urlrewrite.RuleChain.handleRewrite(RuleChain.java:176)\\n\\tat org.tuckey.web.filters.urlrewrite.RuleChain.doRules(RuleChain.java:145)\\n\\tat org.tuckey.web.filters.urlrewrite.UrlRewriter.processRequest(UrlRewriter.java:92)\\n\\tat org.tuckey.web.filters.urlrewrite.UrlRewriteFilter.doFilter(UrlRewriteFilter.java:394)\\n\\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)\\n\\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)\\n\\tat org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233)\\n\\tat org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191)\\n\\tat org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:127)\\n\\tat org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:102)\\n\\tat org.apache.catalina.valves.AccessLogValve.invoke(AccessLogValve.java:555)\\n\\tat org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109)\\n\\tat org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:298)\\n\\tat org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:857)\\n\\tat org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:588)\\n\\tat org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:489)\\n\\tat java.lang.Thread.run(Thread.java:745)\\n"}
]
}


					

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