Types

Top  Previous  Next

 

As you have probably seen on the Methods sections, the Web Service uses specific types as input and output parameters. Here, you can learn what are these types and how to manage them.

 

Type name

Kind

Description

Values range

WSQueryType

Simple

The WSQueryType represents the available query types to be performed on the Web Service. The possible options are "qtSessions", "qtConnections" and "qtBrowsers".

"qtSessions"

"qtConnections"

"qtBrowsers"

 

WSQueryInfo

Complex

This type is used to send a filter criteria to the server when running a search method. It is composed by the queryTypeField (WSQueryType) and the queryRangeField (WSQueryRange).

 

 

WSQueryRange

Complex

This type is used to send a date filter criteria to the server when running a search method. It is composed by the dateFromField and the dateToField.

 

WSDBRecord

Simple

This type is a generalization interface of all analytics record types (WSLoginRecord, WSDBSessionRecord, WSDBConnectionRecord and WSDBBrowserRecord).

 

 

WSDBRecordArray

Simple

An Array of WSDBRecord. It is used mostly as an output parameter for methods that retrieve more than one WSDBRecord from the server.

 

 

WSDBLoginRecord

Complex

The WSDBLoginRecord describes how a Login record is structured.

 

WSDBSessionRecord

Complex

The WSDBSessionRecord type describes how a Session record is structured.

 

WSDBConnectionRecord

Complex

The WSDBConnectionRecord type describes how a Connection record is structured.

 

WSDBBrowserRecord

Complex

The WSDBBrowserRecord type describes how a Browser record is structured.