Back to API references

SOAP API method WebSite_webSession

Description

Get access to a websession object based on its ID.

Parameters

Name Type Description
id * int Unique identifier (id) of the object WebSite. The method only applies to the website with this id.
identifier * string Unique ID
expiredToo boolean Also return sessions that have already expired
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.