Utilize to display a list of most used search engines through which visitors find your site by order of popularity.
This API produces a json array.
One or more of the following parameters are required:
date Calculate the top search engines from the specified date entered as yyyy-MM-dd. Default is the current date.
unixTime Calculate top search engines from the specified unix timestamp. Default is the current unix timestamp.
period The time-range considered for calculating top search engines with respect to date. For example: 3d for 3 days offset.
detailLevel The detail level, either the search entire domain, or only the hostname. [hostname] | domain.
filterByEngine Filter by search engine. If set then only show search engines containing the value set. Wild cards can be used. Example: *google* searches for google.de, google.nl, google.com etc.
timezone Calculate search engines for the specified timezone. The default is the site's defined timezone.
limit The number of rows to show [100].
Optional parameters:
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.
segment This is the property field based on which you want to segment the data. By default there are no segments. You can find more information here.
filter You can choose to see no segments [none] (default), see all segments showAllSorts, or by specifying the name of the segment.
site The site to display data for. 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 [false]|true.
dataType The dataType parameter determines format of data returned. Values can be [ json ] | html | jsondatatable | jsonjqgrid
dateFormat The dateFormat parameter determines format of dates returned. An example is dateFormat=yyyy-dd-MM. The syntax can be found here.
Display a top engines for the website www.opentracker.net for the user "demo@opentracker.net" with password "demo123":
HTTP GET/ POST:/api/top_lists/top_search_engines.jsp?period=1d&login=demo@opentracker.net&password=demo123&site=www.opentracker.net
Display a top engines list for the website www.opentracker.net from 2010-03-03 and three days back display in html:
HTTP GET/ POST:/api/top_lists/top_search_engines.jsp?date=2010-3-3&login=demo@opentracker.net&password=demo123&site=www.opentracker.net&period=3d&dataType=html
Display a top engines list for the website www.opentracker.net from now to three days back:
HTTP GET/ POST:/api/top_lists/top_search_engines.jsp?period=3d
This last example returns a json array with 'n' entries starting from the specified period formatted as:
{ "resultsList": [
{
"No.":"1",
"search engine":"google",
"sessions":"6655",
"graph":"||||||||||||||||||||",
"events":"17589",
"avg. pv/ v":"2.6",
"events_bar":"||||||||||||||||||||"}
,
{
"No.":"2",
"search engine":"bing",
"sessions":"71",
"graph":"|",
"events":"147",
"avg. pv/ v":"2.1",
"events_bar":"|"}
,
{
"No.":"3",
"search engine":"duckduckgo",
"sessions":"22",
"graph":"|",
"events":"45",
"avg. pv/ v":"2",
"events_bar":"|"}
,
{
"No.":"4",
"search engine":"yahoo",
"sessions":"8",
"graph":"|",
"events":"22",
"avg. pv/ v":"2.8",
"events_bar":"|"}
,
{
"No.":"5",
"search engine":"yandex",
"sessions":"5",
"graph":"|",
"events":"11",
"avg. pv/ v":"2.2",
"events_bar":"|"}
,
{
"No.":"6",
"search engine":"ecosia",
"sessions":"3",
"graph":"|",
"events":"3",
"avg. pv/ v":"1",
"events_bar":"|"}
,
{
"No.":"7",
"search engine":"msn",
"sessions":"1",
"graph":"|",
"events":"1",
"avg. pv/ v":"1",
"events_bar":"|"}
,
{
"No.":"",
"search engine":"",
"sessions":"",
"graph":"",
"events":"17,818",
"avg. pv/ v":"17818",
"events_bar":""}
]
}
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