Top Pages

Display a list of top pages by popularity.

API Usage

This API produces a json array.

Parameters

One or more of the following parameters are required:

date Calculate the top pages from the specified date entered as yyyy-MM-dd. Default is the current date.
unixTime Calculate the top pages from the specified unix timestamp. Default is the current unix timestamp.
period The time-range considered for calculating the top pages with respect to the date. For example: 3d for 3 days offset.
filterByUrl Filter by url. If set then only show urls containing the value set. Wild cards can be used. Example: *www.opentracker.net/de/demo* searches for all exit links containing 'www.opentracker.net/de/demo'.
filterByUrlTerm Filter by a term in the url. If set then only show urls containing the specified term. Example: filterByUrlTerm=demo searches for all urls containing the term 'demo'.
ignoreQuery Ignore query string to determine top pages. If set then only show urls excluding the query string. [false]|true.
timezone Calculate most popular pages for the specified timezone. Default is the site's defined timezone.
limit The number of rows to show. Default is [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.
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 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 pages for the website www.opentracker.net for the user "demo@opentracker.net" with password "demo123":
HTTP GET/ POST:/api/top_lists/top_pages.jsp?period=1d&login=demo@opentracker.net&password=demo123&site=www.opentracker.net&date=2012-02-01
Display a top pages list for the website www.opentracker.net from 2012-02-01 and three days back display in html:
HTTP GET/ POST:/api/top_lists/top_pages.jsp?date=2012-02-01&login=demo@opentracker.net&password=demo123&site=www.opentracker.net&period=3d&dataType=html
Display a top pages list for the website www.opentracker.net from now to one day back:
HTTP GET/ POST:/api/top_lists/top_pages.jsp?period=1d&date=2012-02-01

Response

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

{ "resultsList": [
{
"No.":"1",
"raw url":"http:\/\/www.opentracker.net",
"visits":"405",
"graph":"❙",
"events":"441",
"events_bar":"❙"}
,
{
"No.":"2",
"raw url":"http:\/\/www.opentracker.net\/loginpage",
"visits":"200",
"graph":"❙",
"events":"232",
"events_bar":"❙"}
,
{
"No.":"3",
"raw url":"http:\/\/www.opentracker.net\/article\/hits-or-pageviews",
"visits":"186",
"graph":"❙",
"events":"196",
"events_bar":"❙"}
,

...

,
{
"No.":"99",
"raw url":"http:\/\/reporting.texterity.com\/login\/preferences\/account.jsp",
"visits":"2",
"graph":"ǀ",
"events":"3",
"events_bar":"ǀ"}
,
{
"No.":"100",
"raw url":"http:\/\/reporting.texterity.com\/login\/traffic\/trend_hourly.jsp",
"visits":"2",
"graph":"ǀ",
"events":"2",
"events_bar":"ǀ"}
,
{
"No.":"",
"raw url":"",
"visits":"",
"graph":"",
"events":"2,246",
"events_bar":"❙❙❙❙❙❙❙"}
]
}

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