com.fortanix.sdkms.v1.api

Class StatsApi

java.lang.Object

com.fortanix.sdkms.v1.api.StatsApi

public class StatsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
StatsApi()
StatsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
StatsResponse	getAppsStats(Integer rangeFrom, Integer rangeTo, Integer topCount, Integer numPoints) Get app aggregate transaction statistics This is for obtaining app level aggregate transaction statistics to find top apps by transaction.
StatsResponse	getAppStats(String appId, Integer rangeFrom, Integer rangeTo, Integer numPoints) Get transaction statistics for a specific application This API is for obtaining transaction statistics for a specific application.
StatsResponse	getGroupsStats(Integer rangeFrom, Integer rangeTo, Integer topCount, Integer numPoints) Get group aggregate transaction statistics This is for obtaining group level aggregate transaction statistics to find top groups by transaction.
StatsResponse	getGroupStats(String groupId, Integer rangeFrom, Integer rangeTo, Integer numPoints) Get transaction statistics for a specific group This API is for obtaining transaction statistics for a specific group.
StatsResponse	getSecurityObjectStats(String keyId, Integer rangeFrom, Integer rangeTo, Integer numPoints) Get transaction statistics for a specific security object This API is for obtaining transaction statistics for a specific security object.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatsApi

public StatsApi()

StatsApi

public StatsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAppStats

public StatsResponse getAppStats(String appId,
                                 Integer rangeFrom,
                                 Integer rangeTo,
                                 Integer numPoints)
                          throws ApiException

Get transaction statistics for a specific application This API is for obtaining transaction statistics for a specific application. API supports query parameters for fetchings stats for specific time period and with number of data points desired.

Parameters:

appId - Application Identifier (required)

rangeFrom - Starting time for search , this is EPOCH value (optional)

rangeTo - Ending time for search , this is EPOCH value (optional)

numPoints - Number of data points desired (optional)

Returns:

StatsResponse

Throws:

ApiException - if fails to make API call

getAppsStats

public StatsResponse getAppsStats(Integer rangeFrom,
                                  Integer rangeTo,
                                  Integer topCount,
                                  Integer numPoints)
                           throws ApiException

Get app aggregate transaction statistics This is for obtaining app level aggregate transaction statistics to find top apps by transaction. API supports query parameters for fetchings stats for specific time period, for maximum top count and with number of data points desired.

Parameters:

rangeFrom - Starting time for search , this is EPOCH value (optional)

rangeTo - Ending time for search , this is EPOCH value (optional)

topCount - Maximum top count for statistics query (optional)

numPoints - Number of data points desired (optional)

Returns:

StatsResponse

Throws:

ApiException - if fails to make API call

getGroupStats

public StatsResponse getGroupStats(String groupId,
                                   Integer rangeFrom,
                                   Integer rangeTo,
                                   Integer numPoints)
                            throws ApiException

Get transaction statistics for a specific group This API is for obtaining transaction statistics for a specific group. API supports query parameters for fetchings stats for specific time period and with number of data points desired.

Parameters:

groupId - Group Identifier (required)

rangeFrom - Starting time for search , this is EPOCH value (optional)

rangeTo - Ending time for search , this is EPOCH value (optional)

numPoints - Number of data points desired (optional)

Returns:

StatsResponse

Throws:

ApiException - if fails to make API call

getGroupsStats

public StatsResponse getGroupsStats(Integer rangeFrom,
                                    Integer rangeTo,
                                    Integer topCount,
                                    Integer numPoints)
                             throws ApiException

Get group aggregate transaction statistics This is for obtaining group level aggregate transaction statistics to find top groups by transaction. API supports query parameters for fetchings stats for specific time period, for maximum top count and with number of data points desired.

Parameters:

rangeFrom - Starting time for search , this is EPOCH value (optional)

rangeTo - Ending time for search , this is EPOCH value (optional)

topCount - Maximum top count for statistics query (optional)

numPoints - Number of data points desired (optional)

Returns:

StatsResponse

Throws:

ApiException - if fails to make API call

getSecurityObjectStats

public StatsResponse getSecurityObjectStats(String keyId,
                                            Integer rangeFrom,
                                            Integer rangeTo,
                                            Integer numPoints)
                                     throws ApiException

Get transaction statistics for a specific security object This API is for obtaining transaction statistics for a specific security object. API supports query parameters for fetchings stats for specific time period and with number of data points desired.

Parameters:

keyId - kid of security object (required)

rangeFrom - Starting time for search , this is EPOCH value (optional)

rangeTo - Ending time for search , this is EPOCH value (optional)

numPoints - Number of data points desired (optional)

Returns:

StatsResponse

Throws:

ApiException - if fails to make API call