Analyst's Guide

Tracking file format

The tracker creates gzipped files in CSV format.

The CSV format has the following properties:

• Encoding : UTF-8
• Separator: tab
• Quoting character : "
• Escape character : \
• 1 line of header, prefixed by #

Default columns

The following columns are always generated, in the order given:

Name	Data	Notes
server_ts	Timestamp (server-side) of the received events.	Format is yyyy/mm/dd-HH:mm:ss.SSS
client_ts	Timestamp (client-side)	Timestamp sent by the API client.
client_addr	Address of the client (IPv4 or IPv6)	Determined by looking in order at the X-Forwarded-For header, the X-Real-IP header, or the HTTP client IP address on the network connection.
visitor_id	Visitor identifier	Value provided in the client request, or a unique id prefixed with 'Z' if none.
session_id	Session identifier	Value provided in the client request, or a unique id prefixed with 'Z' if none.
location	URL of the page on which the event was recorded	Referer header for pixel request, or page field for the JSON API.
referer	URL of the referer of the page on which the event was recorded	Might not be available if the JSON API was used
user-agent	User-Agent string of the event's browser	Might not be available if the JSON API was used
type	"Type" of the event: * "page", if the "trackPage" method was used * "event", if the "trackEvent" method was used
visitor_params	Visitor-scope custom variables, if any. See Custom variables for details.	Custom variables are written in UTF-8 encoded, URL-escaped, query string form. Example: param1=value1&param2=value2&param3=value%20with%20spaces
session_params	Session-scope custom variables, if any. See Custom variables for more details.	Custom variables are written in UTF-8 encoded, URL-escaped, query string form. Example: param1=value1&param2=value2&param3=value%20with%20spaces
event_params	Event-scope custom variables, if any. See Custom variables for more details.	Custom variables are written in UTF-8 encoded, URL-escaped, query string form. Example: param1=value1&param2=value2&param3=value%20with%20spaces
br_width	Width of the user's browser window	Might not be available if the JSON API was used
br_height	Height of the user's browser window	Might not be available if the JSON API was used
sc_width	Width of the user's screen	Might not be available if the JSON API was used
sc_height	Height of the user's screen	Might not be available if the JSON API was used
br_lang	Language of the user's browser	Might not be available if the JSON API was used
tz_off	TImezone offset of the user's browser, in minutes to UTC.For example, in Paris (UTC+0100), tz_off value is -60	Might not be available if the JSON API was used

Optional columns

The following columns are optionally generated, in the order given, depending on the configuration.

Name	Data	Notes
global_visitor_id	Global visitor identifier	Generated only if third-party cookie tracking is enabled. See Cookies usage for details.
Inlined visitor parameter names	Inlined visitor parameter values	Each visitor-scope parameter named in the inlinedVisitorParams configuration parameter, if present, is extracted from the visitor_params column above and logged as an additional individual column, without URL-escaping.
Inlined session parameter names	Inlined session parameter values	Each session-scope parameter named in the inlinedSessionParams configuration parameter, if present, is extracted from the session_params column above and logged as an additional individual column, without URL-escaping.
Inlined event parameter names	Inlined event parameter values	Each event-scope parameter named in the inlinedEventParams configuration parameter, if present, is extracted from the event_params column above and logged as an additional individual column, without URL-escaping.