Note: This documentation is for Opentracker's events engine, please contact us if you think you need an upgrade.

Reserved property

Reserved properties are used by the engine's internal logic. We advise to first test with a test account before moving towards production.

Reserved property Function
si your registered site, app or account
eid event id
sid session id, overrides any session id encapsulated in ots if given.
uid user id, overrides any user id encapsulated in otui if given.
ots session state data: A variable which keeps track of the state of a session. Keeping track of state is expensive, in terms of resources. The state (like how many pages has been viewed) is kept on the client. The state is a string of numbers build up as follows:
<session event view count>.<current visit start unix timestamp>.<previous event view unix timestamp>.<current event view unix timestamp>.
You'll find this state being kept in cookies, or a file on android or iOS device. The state is used in many reports, for example to calculate how long a person looks at a page. The session id can be determined from this state value.
otui user state data: A variable which keeps track of the state of a user.
<random number client site>.<first visit start unix timestamp>.<previous visit start unix timestamp>.<current visit start unix timestamp>.<session count>.<life time event view count>,
The state is used in many reports.
proxy If the request sending the data has the property name 'proxy' defined then this signifies that this is not the original source of the data. This is useful if you are updating information from a proxy and do not want the engine to automatically populate geographic and user-agent based data. The variable increment is automatically set to false.
increment [true| false] The variable increment is by default true, meaning that reports based on counting will work for this request. If proxy is set then this automatically set to false.
browser the browser being used for this request (automatically detected from the user agent if not given)
browserVersion the browser version being used for this request (automatically detected from the user agent if not given)
connection the connection for this request, for example Cable or ADSL (automatically detected if not given)
eh effective screen height
ew effective screen width
fv [true|false] is this visit the first session?
ignore [true|false] ignore this event in the clickstream
ip override the request's ip number with this ip number. all geographic data will map to this ip number
lc url of this event
locale the language/ locale used for this event
otor the original referrer of the user id; given as: <unixtimestamp.url> eg: 1279273431384.http%3A//
otpe the previous location (url), used to calculate viewed time for pages
otr the referrer of the sessions id; given as: <unixtimestamp.url> eg: 1279273431384.http%3A//
platform the platform making this request (Eg Windows/ OS X). If not given, then this is automatically detected from the user agent.
pix if set then this api request returns a single pixel, this is useful if you want the api to return an image
ref the current referrer
sc screen colors
sh screen height
sw screen width
ti the title of the event, this shows up in the user's clickstream
tz the timezone given

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