Back to API references

SOAP API method WebSite_createWebSession


To register impressions and clicks, and to process webforms and surveys, you need a websession object that holds session information. This method can be used to construct a new session object. The ID of the returned object should be used for retrieving the same session object in subsequent calls. It is best to use a cookie for storing the session ID so that subsequent calls can use the same session object.


Name Type Description
id * int Unique identifier (id) of the object WebSite. The method only applies to the website with this id.
ip * string IP address
host * string hostname
useragent * string User agent string
referer * string Referer
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
websession Structure of type 'websession'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'websession'

Name Type Description
id string Unique identifier for the session.
firstimpression timestamp When was the first impression during this session?
lastimpression timestamp When was the last impression during this session?
duration integer Duration of the session.
ip string The IP address of the visitor.