Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

They will therefore always be available and it will not be necessary to register specifically, the system will do so automatically.

Detail of default contextual parameters

surfer.uid

UID of the surfer who triggered the event
example: user_57

surfer.login

User Login
example: user@application.fr

surfer.role.uid

UID of the user role
example: role_32

surfer.role.name

Name of the user’s role (name)
example: writer

surfer.locale.language

Language code in ISO-639 format
example: en

surfer.locale.country

Region code in ISO-3166 format
example: FR

session.uid

Login of the session
example: 651dqqsd54eea11ff (non-representative)

session.duration

Time elapsed since the start of the session (in ms)
example: 25342

session.type

Session type (bo|fo|admin)
example: bo

remoteaddr

User’s IP address
example: 10.11.12.13

referer

Last URL known to the user
example: http://monsite.com/exemple.jspz

remotecountry

Country in which the user is located (ISO-639 code)
example: FR

uri.path

path to the current URL
example: /mypage.jspz

uri.qs

Query String of the current URL
example: param1=12&param2=xyz

user_agent

Browser Agent
example: mozilla/5.0 (x11; linux x86_64) applewebkit/537.36 (khtml, like gecko) chromium/49.0.2623.87 safari/537.36

user_os

Operating system used
example: Linux

user_browsergroup

Browser used (group name)
example: chrome

user_browser

Browser version used
example: Chrome 49

Note

Important

All those parameters are systematically saved by the application for each event.

Access to context parameters

In dashboards, context parameters can be used to filter data in search options or as data used to represent to the user.

...

Code Block
connexion_search_option.putAggregation("pie_connexions_by_role", Analytics.TermsAggregation("event.context.surfer.role.uid", 20));

Logging extra custom surfers parameters

Since 11.15.0 it is now possible to add custom surfer’s parameters to the context parameters. Simply add the structure field tag analytics/surfer on any user property to have it logged at each analytics event.

...

A custom context parameter will always be retrieved with event.context.extra.VARIABLE_NAMENAMEuid.

...

Note

The uid suffix at the end of the parameter name is automatically added by the application on child and child multiple properties.