Trends

Display and analyze trends in website traffic through time.

Display and analyze trends in website traffic through time.

API Usage

This API produces a json array. Use this URL to perform GET or POST requests.

Parameters

At least one of the following parameters are required:

date Calculate trends from specified date entered as yyyy-MM-dd. Default is the current date.
unixTime Calculate trends from specified unix timestamp. Default is current unix timestamp.
period Specify the trend period.

  • "x"d for days, eg: period=14d will show 14rows with daily trends, period=d defaults to 1 day
  • "x"w for weeks, eg: period=12w will show 12 rows with weekly trends, period=1w defaults to 1 week
  • "x"m for months, eg: period=4m will show 4 rows with monthly trends, period=1m defaults to 1 month

timezone The timezone used. Use this option if more than one timezone is being recorded, by default the site's defined timezone is used.
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 for which to display data. The 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 | csv | svg | png.
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 calculate the daily trends to the website www.opentracker.net for the user "demo@opentracker.net" with password "demo123":
HTTP GET/ POST: trends.jsp?login=demo@opentracker.net&password=demo123&site=www.opentracker.net&period=1d

To calculate the weekly trends of the week where the date 2017-12-09 falls and display in html:
HTTP GET/ POST:trends.jsp?period=1w&date=2017-12-09&dataType=html

To calculate the monthly trends over a range of 3 months from now/ current month:
HTTP GET/ POST:trends.jsp?period=3m

Response

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

{ "resultsList": [
{
"No.":"3",
"date":"Dec, 2017",
"sessions":"1,934",
"visitors":"1,845",
"first time visitors":"1,714",
"returning":"131",
"referred":"1,527",
"searching":"1,406",
"exit link":"400",
"pageviews":"3,540",
"end date":"2017-12-11",
"segment":"",
"single event sessions":"1,584",
"total duration all sessions":"78,483",
"start date":"2017-12-01",
"sessionsWithMoreThanOneEvent":""}
,
{
"No.":"2",
"date":"Nov, 2017",
"sessions":"12,189",
"visitors":"11,855",
"first time visitors":"11,377",
"returning":"478",
"referred":"4,498",
"searching":"4,134",
"exit link":"1,404",
"pageviews":"17,018",
"end date":"2017-11-30",
"segment":"",
"single event sessions":"10,917",
"total duration all sessions":"284,642",
"start date":"2017-11-01",
"sessionsWithMoreThanOneEvent":""}
,
{
"No.":"1",
"date":"Oct, 2017",
"sessions":"9,488",
"visitors":"8,870",
"first time visitors":"8,172",
"returning":"698",
"referred":"7,125",
"searching":"6,565",
"exit link":"1,608",
"pageviews":"18,517",
"end date":"2017-10-31",
"segment":"",
"single event sessions":"7,578",
"total duration all sessions":"447,908",
"start date":"2017-10-01",
"sessionsWithMoreThanOneEvent":""}
,
{
"No.":"",
"date":"",
"sessions":"23,611",
"visitors":"22,570",
"first time visitors":"21,263",
"returning":"1,307",
"referred":"13,150",
"searching":"12,105",
"exit link":"3,412",
"pageviews":"39,075",
"single event sessions":"20,079",
"total duration all sessions":"811,033",
"end date":"",
"segment":"",
"start date":"",
"sessionsWithMoreThanOneEvent":""}
]
}

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