Geo location - ZIP & Postal Codes (US & Canada only)

Display a list of the ZIP & Postal codes of US and Canada where your visitors come from.

API Usage

This API produces a json array.

Parameters

One or more of the following parameters are required:

date Calculate the top ZIP & postal codes from the specified date entered as yyyy-MM-dd. Default is the current date.
unixTime Calculate the top ZIP & postal codes 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 top ZIP & postal codes for the specified timezone. The 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 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 top postal codes for the website www.opentracker.net for the user "demo@opentracker.net" with password "demo123":
HTTP GET/ POST:/api/location/top_postal_codes.jsp?period=1d&login=demo@opentracker.net&password=demo123&site=www.opentracker.net
Display a top postal codes list for the website www.opentracker.net from 2010-03-03 and three weeks back display in html:
HTTP GET/ POST:/api/location/top_postal_codes.jsp?date=2010-3-3&login=demo@opentracker.net&password=demo123&site=www.opentracker.net&period=3w&dataType=html
Display a top postal codes list for the website www.opentracker.net for the day of 2010-4-1:
HTTP GET/ POST:/api/location/top_postal_codes.jsp?period=1d&date=2010-4-1

Response

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

{ "resultsList": [
{
"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