Operator Statistics Utility

The Operator Statistics Utility Web Service allows the Operator to retrieve the statistics generated in Oracle Communications Services Gatekeeper.

Interface: OpStatisticsUtil

The endpoint for this interface is: http://<host>:<port>/prm_op/services/OpStatisticsUtil

where the value for host and port depend on the Oracle Communications Services Gatekeeper deployment.

listStatisticTypes

Lists the statistics types registered in Oracle Communications Services Gatekeeper.l

Table 13-1 listStatisticTypes()
Parameter Name	Type	Description
Input
No input parameters.
Returns
listStatisticTypesReturn	Array of tns1:StatisticTypeDescriptor	Descriptions of available statistics types. See StatisticTypeDescriptor.
Possible Exceptions
ACCESS_DENIED
CommonException

getStatistics

Table 13-2 getStatistics(statisticType, fromDate, toDate, spAccountId, appAccountId)
Parameter Name	Type	Description
Input
statisticType	xsd:int	Number representing the type of statistics to retrieve.
fromDate	xsd:dateTime	From date and time. Use null to not filter on this parameter
toDate	xsd:dateTime	To date and time. Use null to not filter on this parameter.
spAccountId	xsd:string	ID of the Service Provider Account to filter the result on. Use null to not filter on this parameter
appAccountId	xsd:string	ID of the Application Account to filter the result on. Use null to not filter on this parameter
Returns
getStatisticsReturn	Array of tns1:StatisticsInfo	Statistics. See StatisticsInfo.
Possible Exceptions
ACCESS_DENIED
CommonException

Exceptions

CommonException

This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.

Data types

StatisticsInfo

Data structure defining a statistics record. All services that produce statistics do not use all fields, and they use the fields slightly differently, depending on the type of the service.

Table 13-3 StatisticsInfo
Element name	Datatype	Description
statisticsType	xsd:string	The statistics type.
timeStampStart	xsd:dateTime	The starting time of the interval during which the statistics were gathered.
timeStampEnd	xsd:dateTime	The end time of the interval during which the statistics were gathered.
numberOfTransactions	xsd:int	The number of transactions during the interval.
spAccountId	xsd:string	The ID of the Service Provider that generated the statistics.
appAccountId	xsd:string	The ID of the Application Account that generated the statistics.

StatisticTypeDescriptor

Table 13-4 AlarmSeverity
Element name	Datatype	Description
transactionTypeName	xsd:string	Name of a transaction type that statistics can be generated for.
transactionTypeId	xsd:int	Numeric ID of the transaction type.

Integration Guidelines for Partner Relationship Management