GetStatistics (v3)

GetStatistics (v3)

Overview

Reads user and tenant statistics.

The function is available as a Web Service request.

Request

Parameters of the API request:

Parameter

Type

Description

Requirements

Parameter

Type

Description

Requirements

token

String

API authentication token

Mandatory

filter

 CallStatisticsFilter

Statistics filter

Mandatory

Response

Parameters of the API response:

Parameter

Type

Description

Parameter

Type

Description

return

StatisticsResponse

Possible return values:

Examples

 

Example GetStatistics transaction.
Request: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/"> <soapenv:Header/> <soapenv:Body> <v3:getStatistics> <token>uMeNlt2mG5K3l71MeV4eEDqyRB97RjAD</token> <filter> <environmentFilter> <eid>0000</eid> <eidExact>0</eidExact> <inactive>0</inactive> <!-- Needed if eid is not present <shortName></shortName> <shortNameExact></shortNameExact> --> </environmentFilter> <source>BOTH</source> <timeFrom>2015.01.01 08:00:00.000</timeFrom> <timeTo>2015.12.01 18:00:00.000</timeTo> <type>BY_USER</type> </filter> </v3:getStatistics> </soapenv:Body> </soapenv:Envelope> Response: <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getStatisticsResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/"> <return> <callStatistics> <eid>0000</eid> <lengthOfCallsSeconds>235</lengthOfCallsSeconds> <loginName>IPTUser</loginName> <numberOfCalls>30</numberOfCalls> <shortName>Ref.</shortName> <userId>7</userId> </callStatistics> <callStatistics> <eid>0000</eid> <lengthOfCallsSeconds>22</lengthOfCallsSeconds> <loginName>balazs</loginName> <numberOfCalls>1</numberOfCalls> <shortName>Ref.</shortName> <userId>3</userId> </callStatistics> <status> <statusCode>OK</statusCode> </status> </return> </ns2:getStatisticsResponse> </S:Body> </S:Envelope>