Class ClickStreamEntry
dw.web
Class ClickStreamEntry
Object
dw.web.ClickStreamEntry
Represent an entry in the click stream.
Properties
host  :  String  (Read Only)
The host.
locale  :  String  (Read Only)
The locale sent from the user agent.
path  :  String  (Read Only)
The path.
pipelineName  :  String  (Read Only)
The name of the called pipeline. In most cases the name can be derived from the path, but not in all cases. If with URL rewritting a special landing page is defined for a DNS name, than the system internally might use a specific pipeline associated with this landing page.
queryString  :  String  (Read Only)
The query string.
referer  :  String  (Read Only)
The referer.
remoteAddress  :  String  (Read Only)
The remote address.
timestamp  :  Number  (Read Only)
The entry's timestamp.
url  :  String  (Read Only)
The full URL for this click. The URL is returned as relative URL.
userAgent  :  String  (Read Only)
The user agent.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getHost() : String
Returns the host.
getLocale() : String
Returns the locale sent from the user agent.
getParameter(name : String) : String
Returns a specific parameter value from the stored query string.
getPath() : String
Returns the path.
getPipelineName() : String
Returns the name of the called pipeline.
getQueryString() : String
Returns the query string.
getReferer() : String
Returns the referer.
getRemoteAddress() : String
Returns the remote address.
getTimestamp() : Number
Returns the entry's timestamp.
getUrl() : String
Returns the full URL for this click.
getUserAgent() : String
Returns the user agent.
Method Detail
getHost
getHost() : String
Returns the host.
Returns:
the host.

getLocale
getLocale() : String
Returns the locale sent from the user agent.
Returns:
the locale sent from the user agent.

getParameter
getParameter(name : String) : String
Returns a specific parameter value from the stored query string. The method can be used to extract a source code or affiliate id out of the URLs in the click stream. The method returns null if there is no parameter with the given name.
Parameters:
name - the name of the parameter.
Returns:
the value associated with the specified parameter, or null.

getPath
getPath() : String
Returns the path.
Returns:
the path.

getPipelineName
getPipelineName() : String
Returns the name of the called pipeline. In most cases the name can be derived from the path, but not in all cases. If with URL rewritting a special landing page is defined for a DNS name, than the system internally might use a specific pipeline associated with this landing page.
Returns:
the name of the called pipeline.

getQueryString
getQueryString() : String
Returns the query string.
Returns:
the query string.

getReferer
getReferer() : String
Returns the referer.
Returns:
the referer.

getRemoteAddress
getRemoteAddress() : String
Returns the remote address.
Returns:
the remote address.

getTimestamp
getTimestamp() : Number
Returns the entry's timestamp.
Returns:
the entry's timestamp.

getUrl
getUrl() : String
Returns the full URL for this click. The URL is returned as relative URL.
Returns:
the full URL for this click.

getUserAgent
getUserAgent() : String
Returns the user agent.
Returns:
the user agent.