Clickstream Standard Columns Reference

Overview

The clickstream transformations use various column definitions during their processing. Each of these columns is intended to fulfill a specific purpose during processing.

Clickstream Parse Input Columns

The Clickstream Log transformation maps the columns from a Web log to the Clickstream Parse Input Columns and loads an output table with data from the log. This table becomes the input to the Clickstream Parse transformation.
The following table lists the metadata for the Clickstream Parse input columns.
Clickstream Log Output Columns
Column Name
Description
Label
Length
SAS Format
CLK_Client_IP
Specifies the visitor's IP address.
Client ID
64
$64.
CLK_cs_Bytes
Specifies the number of bytes that the client sends to the server, upon a server request.
Bytes Received
8
COMMA15.
CLK_cs_Cookie
Specifies the raw cookie string.
Cookie String
4096
$4096.
CLK_cs_Host
Specifies the host name, which is derived from the URL field that follows http://.
Requested Host
64
$64.
CLK_cs_Method
Specifies the method that is used to submit the request (for example, POST or GET).
HTTP Method
16
$16.
CLK_cs_Referrer
Specifies the full URL and any query parameters from the referring page.
Referrer
1332
$1332.
CLK_cs_URI_Query
Specifies the query string that is passed to the URL.
Query Sting
1332
$1332.
CLK_cs_URI_Stem
Specifies the URI, which is the URL, but without the http://www.domain.com/ field.
Requested File
1332
$1332.
CLK_cs_UserAgent
Specifies the string that identifies the user's browser, which the user's browser sends.
User Agent
271
$271.
CLK_cs_Username
Specifies the user name that the client used for authentication, if applicable.
Username
42
$42.
CLK_cs_Version
Specifies the version of the HTTP protocol that is being used.
HTTP Version
8
$8.
CLK_Date
Specifies the date stamp of the request.
Date
8
DATE9.
CLK_GMT_Offset
Specifies the Greenwich Mean Time (GMT) offset.
GMT Offset
5
$5.
CLK_Null
Specifies the placeholder for a field that is not being used.
Null Variable
8
$8.
CLK_s_Server
Specifies the server name, such as s-ComputerName.
Server Name
48
$48.
CLK_s_Server_IP
Specifies the IP address of the Web server.
Server IP Address
16
$16.
CLK_s_Server_Port
Specifies the number of the port that the Web server runs on.
Server Port
8
$8.
CLK_s_Sitename
Specifies the name of the virtual Web site.
Site Name
32
$32.
CLK_sc_Bytes
Specifies the number of bytes that the server sends to the client, upon a client request.
Bytes Sent
8
COMMA15.
CLK_sc_Status
Specifies the HTTP status code that the client receives from the server.
HTTP Status
8
4.
CLK_sc_SubStatus
Specifies the secondary status that is returned by some Web servers.
Sub Status
8
4.
CLK_Time
Specifies the timestamp of the request.
Time
8
TIME.
CLK_Time_Taken
Specifies the amount of time that is taken for the server to respond to the client request.
Time Taken
8
TIME.
CLK_sc_Win32_Status
Specifies the status that is returned by the Windows operating system.
Win32 Status
8
4.

Clickstream Parse Output Columns

The Clickstream Parse transformation processes the columns received in its input table and produces an output table containing a derived set of output columns.
The following table lists the metadata for the Clickstream Parse output columns.
Clickstream Parse Output Columns
Column Name
Description
Completion Method
Label
Length
SAS Format
Browser
Specifies the type of browser that the visitor uses.
Is derived from CLK_cs_UserAgent, by using pattern matching on known browser names.
Browser
52
$52.
Browser_Version
Specifies the version of the browser that the visitor uses.
Is derived from CLK_cs_UserAgent by using pattern matching to locate the browser name, and then extracting the version number that follows it.
Browser Version
16
$16.
Bytes_Received
Specifies the number of bytes that the client sends to the server.
Pass-through CLK_cs_Bytes.
Bytes Received
8
COMMA15.
Bytes_Sent
Specifies the number of bytes that the server sends to the client.
Pass-through CLK_sc_Bytes.
Bytes Sent
8
COMMA15.
Client_IP
Specifies the visitor's IP address.
Pass-through CLK_Client_IP.
Client IP
64
$64.
Cookie_Jar
Specifies the raw contents of the cookie jar.
Pass-through CLK_cs_Cookie.
Cookie Jar
4096
$4096.
Date_Time
Specifies the date and time of the request.
Is derived by combining CLK_Date and CLK_Time.
Date and Time
8
DATETIME.
Domain
Specifies the host name.
Pass-through CLK_cs_Host.
Domain
165
$165.
Method
Specifies the method that is used to submit the request (for example, POST or GET).
Pass-through CLK_cs_Method.
Method
16
$16.
Platform
Specifies the hardware platform of the visitor's computer.
Is derived from CLK_cs_UserAgent, by using pattern matching on known platform names.
Platform
78
$78.
Query_String
Contains the parameters that are specified in the URL. It is also referred to as the query or the CGI parameters.
Uses the pass-through CLK_URI_Query if non-blank. Otherwise, this query uses the query string from CLK_cs_URI_Stem.
Query String
1332
$1332.
Record_ID
Specifies the unique identifier for each record.
Is derived by combining the date of the SAS process, the SAS process ID, and the record counter.
Record ID
24
$24.
Referrer
Specifies the referring page (the URL from which the user requests access to the next URL).
Pass-through CLK_cs_Referrer.
Referrer
1332
$1332.
Referrer_Domain
Specifies the domain of the referrer.
Is derived from CLK_cs_Referrer, and is the text that is located between the protocol (http://) and the first-level path (/).
Referrer Domain
165
$165.
Referrer_Internal
Specifies whether the referrer is internal.
Is derived from a user-modified rule that runs after parse and sets referrer_internal to 1 when condition passes.
Referrer Internal
3
$3.
Referrer_Query_String
Specifies the query string that is passed with the referrer.
Is derived from CLK_cs_Referrer, and is the text that is passed in the URL after the question mark (?).
Referrer Query String
1332
$1332.
Referrer_Requested_File
Specifies the path and the filename of the referrer.
Is derived from CLK_cs_Referrer, and is all of the text that is located between the end of the domain name and the query string, if any.
Referrer Requested File
1332
$1332.
Requested_File
Specifies the requested file.
Pass-through CLK_cs_URI_Stem.
Requested_File
1332
$1332.
Server
Specifies the physical computer name that the Web server runs on, such as CLK_s_ComputerName.
Pass-through CLK_s_ComputerName.
Server
32
$32.
Server_IP
Specifies the IP address of the Web server.
Pass-through CLK_s_IP.
Server IP Address
16
$16.
Server_Port
Specifies the port that the Web server runs on, such as CLK_s_Port.
Pass-through CLK_s_Port.
Server Port
8
$8.
Sitename
Specifies the name of the virtual Web site, such as CLK_s_SiteName.
Pass-through CLK_s_SiteName.
Site Name
48
$48.
Status_Code
Specifies the HTTP status code that the server returns to the client during this request.
Pass-through CLK_sc_Status.
Status Code
8
4.
SubStatus
Specifies the secondary status that is returned by some Web servers.
Pass-through CLK_sc_SubStatus.
Sub Status
8
4.
User_Agent
Specifies the string that contains a description of the user's browser, which the user's browser sends.
Pass-through CLK_cs_UserAgent.
User Agent
271
$271.
Username
Specifies the user name that the client sends to the server for authentication, if applicable.
Pass-through CLK_cs_Username.
Username
42
$42.
Visitor_ID
Specifies a unique identifier for a visitor to the site. It typically contains the user's IP address and the name of the browser's user agent.
Is derived by combining CLK_Client_IP and CLK_cs_UserAgent, which is the default value, or by defining a user-defined rule that runs after the Clickstream Parse transformation.
Visitor Identifier
225
$225.

Clickstream Sessionize Output Columns

The Clickstream Sessionize transformation processes the columns received in its input table and produces an output table containing a derived set of output columns. Clickstream Sessionize also passes through each input column automatically.
The following table lists the metadata for the derived Clickstream Sessionize output columns.
Column Name
Description
Completion Method
Label
Length
SAS Format
Session_ID
The assigned session identifier for this visitor session.
User-Defined Rules or AutoFill e-Data Server configuration option (combines CLK_Client_IP and CLK_cs_UserAgent)
Session_ID
245
$245
Session_Closed
Set to 1 to indicate that this record belongs to a closed session. Set to 0 to indicate that this record belongs to an open session.
Set to 1 when a session has exceeded the session timeout value. Otherwise, set to 0.
Session_Closed
3
1.
Entry_Point
Set to 1 for the first click of the visitor’s session. Set to 0 otherwise.
Clicks are examined in date_time order, and the first click entry_point is set to 1. All others are set to 0.
Entry_Point
3
Exit_Point
Set to 1 for the last click of the visitor’s session and it belongs to a closed session. Set to 2 for the last click of the visitor’s session in an open session. Set to 0 otherwise. A value of 2 has been introduced to assist in the identification of exit points for open sessions.
Clicks are examined in date_time order, and final click exit_point is set to 1. All others are set to 0.
Exit_Point
3
1.
Eyeball_Time
Time the visitor has spent on the page before the next click.
Date_time of current click is subtracted from date_time of subsequent click. Last click in a session is set to missing.
Eyeball_Time
8
TIME.