All

Writing data

Docs
- Inserting data [general]
- Opentracker Implementation

Reading data

Visits
- classic
- Next generation
Trends
- trends
- hourly trends
- pages
- summary
Top lists
- pages
- paths
- referrers
- search engines
- search terms
- entry pages
- exit pages
- exit links
- properties
Technical data
Geo-location data
Management

Technical - Display Colors

Display the number of colors supported in visitor display screens.

API Usage

This API produces a json array.

Parameters

One or more of the following parameters are required:

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

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

timeZone Calculate the display colors for the specified timezone. Default is 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 for which dateString display data. 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

Examples

Display a display colors list for the website www.opentracker.net for the user "demo@opentracker.net" with password "demo123":
HTTP GET/ POST: /api/technical/display_colors.jsp?period=1d&login=demo@opentracker.net&password=demo123&site=www.opentracker.net
Display a display colors list for the website www.opentracker.net from 2023-11-28 and three weeks back display in html:
HTTP GET/ POST: /api/technical/display_colors.jsp?date=2023-11-28&login=demo@opentracker.net&password=demo123&site=www.opentracker.net&period=3w&dataType=html
Display a display colors list for the website www.opentracker.net for 2023-4-27:
HTTP GET/ POST: /api/technical/display_colors.jsp?date=2023-11-28

Response

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

{ "resultsList": [
{
"No.":"1",
"display colors":"24",
"users":"4,508",
"bar":"||||||||||||||||||||",
"percentage":"90.6%"}
,
{
"No.":"2",
"display colors":"32",
"users":"336",
"bar":"|",
"percentage":"6.8%"}
,
{
"No.":"3",
"display colors":"30",
"users":"131",
"bar":"|",
"percentage":"2.6%"}
,
{
"No.":"4",
"display colors":"16",
"users":"1",
"bar":"|",
"percentage":"0.0%"}
,
{
"No.":"",
"display colors":"",
"users":"4,976",
"bar":"",
"percentage":"100%"}
]
}

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

All