Note: This API call only works with the new Opentracker Events Engine, please contact us for upgrading to this new technology.

Custom Events

Display and analyze custom events in website traffic on particular day.

Display and analyze custom events 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 custom events from specified date entered as yyyy-MM-dd. Default is the current date.
period The time-range considered for calculating top custom events with respect to the date. Example: 3d for 3 days offset.
customVariable Name of the custom event. Default is [apple].
rows Total numbers to return. The default is [1000].
site The site for which to display data. The default is [www.stackoverflow.com].
dataType The dataType parameter determines the format of the data returned. Values can be [ json ] | html | jsondatatable | jsonjqgrid
segment The classification of custom event is stored.

Examples

To show total custom events for the website stackoverflow.com:
HTTP GET/ POST:top_custom.jsp?site=stackoverflow.com

To show total custom events on a particular date and display in html:
HTTP GET/ POST:top_custom.jsp?date=2012-09-07&dataType=html

To show total custom events on a segment.
HTTP GET/ POST:top_custom.jsp?segment=country

Errors

If errors are encountered, the first encountered error will be returned of form "Error: exception: message

We would love to hear your feedback. Please use the facebook comment box below