Top Search Terms

Display a list of most popular keywords (search terms) visitors entered into a search engine to find your site.

API Usage

This API produces a json array.

Parameters

One or more of the following parameters are required:

date Calculate the top search terms from the specified date entered as yyyy-MM-dd. Default is the current date.
unixTime Calculate the top search terms from the specified unix timestamp. Default is the current unix timestamp.
period The time-range considered for calculating top search terms with respect to the date. Example: 3d for 3 days offset.
detailLevel The detail level; the search term including search engine, or only the searchterm. [search] | searchPlain.
filterBySearchTerm Filter by search term. If set then only show search terms containing the value set.
timezone Calculate the top search terms for the specified timezone. Default is the site's defined timezone.

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 data returned. A list of locales can be found here.
ignoreLocale Display columns without language translation [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 example is dateFormat=yyyy-dd-MM. The syntax can be found here.

Examples

Display a top search terms for the website www.opentracker.net for the user "demo@opentracker.net" with password "demo123":
HTTP GET/ POST:/api/top_lists/top_search_terms.jsp?period=1d&login=demo@opentracker.net&password=demo123&site=www.opentracker.net
Display a top search terms list for the website www.opentracker.net from 2010-03-03 and three weeks back display in html:
HTTP GET/ POST:/api/top_lists/top_search_terms.jsp?date=2010-3-3&login=demo@opentracker.net&password=demo123&site=www.opentracker.net&period=3d&dataType=html

Response

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

error
no-data

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