Class ClickStreamEntry

Represent an entry in the click stream.

Property Summary 

PropertyDescription
host: String (read-only)Returns the host.
locale: String (read-only)Returns the locale sent from the user agent.
path: String (read-only)Returns the path.
pipelineName: String (read-only)Returns the name of the called pipeline.
queryString: String (read-only)Returns the query string.
referer: String (read-only)Returns the referer.
remoteAddress: String (read-only)Returns the remote address.
timestamp: Number (read-only)Returns the entry’s timestamp.
url: String (read-only)Returns the full URL for this click.
userAgent: String (read-only)Returns the user agent.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getHost()Returns the host.
getLocale()Returns the locale sent from the user agent.
getParameter(String)Returns a specific parameter value from the stored query string.
getPath()Returns the path.
getPipelineName()Returns the name of the called pipeline.
getQueryString()Returns the query string.
getReferer()Returns the referer.
getRemoteAddress()Returns the remote address.
getTimestamp()Returns the entry’s timestamp.
getUrl()Returns the full URL for this click.
getUserAgent()Returns the user agent.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

host 

host: String (read-only)

Returns the host.


locale 

locale: String (read-only)

Returns the locale sent from the user agent.


path 

path: String (read-only)

Returns the path.


pipelineName 

pipelineName: String (read-only)

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.


queryString 

queryString: String (read-only)

Returns the query string.


referer 

referer: String (read-only)

Returns the referer.


remoteAddress 

remoteAddress: String (read-only)

Returns the remote address.


timestamp 

timestamp: Number (read-only)

Returns the entry's timestamp.


url 

url: String (read-only)

Returns the full URL for this click. The URL is returned as relative URL.


userAgent 

userAgent: String (read-only)

Returns the user agent.


Method Details 

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(String) 

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.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!