Top Paths

Display a list of most accessed directory and file paths in your domain.

API Usage

This API produces a json array.

Parameters

One or more of the following parameters are required:

date Calculate the top files and directory paths from the specified date entered as yyyy-MM-dd. Default is current date.
unixTime Calculate the top file and directory paths from specified unix timestamp. Default is current unix timestamp.
period The time-range considered for calculating the top file and directory paths with respect to the date. For example: 3d for 3 days offset, 3w for 3 weeks and 3m for 3 months.
detailLevel The detail level, either only the domain, or the path. [domain]|path.
filterForDomain Filter by domain. If set then only show domains containing the value set. Wild cards can be used. Example: *opentracker/de* searches for all paths containing 'opentracker/de'.
timezone Calculate the top files and directory paths 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. The 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. The default is [www.opentracker.net].
ignoreLocale Display columns without language translation [false]|true.
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
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 paths for the website www.opentracker.net for the user "demo@opentracker.net" with password "demo123":
HTTP GET/ POST:/api/top_lists/top_paths.jsp?period=1d&login=demo@opentracker.net&password=demo123&site=www.opentracker.net
Display a top paths 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_paths.jsp?date=2010-3-3&login=demo@opentracker.net&password=demo123&site=www.opentracker.net&period=3w&dataType=html
Display a top paths list for the website www.opentracker.net from now to three days back:
HTTP GET/ POST:/api/top_lists/top_paths.jsp?period=3d

Response

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

{ "resultsList": [
{
"No.":"1",
"domain / directory path / file / ?query":"www.opentracker.net",
"sessions":"265",
"graph":"||||||||||||||||||||",
"events":"436",
"events_bar":"||||||||||||||||||||",
"No.":"1"}
,
{
"No.":"2",
"domain / directory path / file / ?query":"landing.opentracker.net",
"sessions":"1",
"graph":"|",
"events":"1",
"events_bar":"|",
"No.":"1"}
,
{
"No.":"",
"domain / directory path / file / ?query":"",
"sessions":"266",
"graph":"",
"events":"437",
"events_bar":"",
"No.":""}
]
}

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