Optimize 10.7 | webMethods Optimize Documentation | Administering webMethods Optimize | For System Administrators | Integration with Software AG MashZone | Constructing Queries to Display Data from Optimize Analytic Engine into MashZone | KPI Instance Readings Parameters
 
KPI Instance Readings Parameters
The following table describes the KPI Instance Readings parameters.
kpiName
String Required when no kpiInstanceId is provided. Specifies the name of the KPI for which to return KPI instance readings.
kpiInstanceId
Integer Required when no kpiName is provided. Specifies a unique identifier of the KPI instance for which you want readings.
dimensionValue
String Optional. Specifies a dimension value for the KPI instance readings that you want returned. Optimize will search through all the dimensions included in the KPI dimension’s hierarchy. The closest match to the provided value is returned. For example, a value of abc will match all strings that contain abc. For an exact match, use quotation marks (“abc”).
aggregationInterval
String Optional. Specifies how you want the service to aggregate the retrieved KPI instance readings. This is helpful when you expect a large amount of data returned. For example, if you set the time period to LAST_YEAR, the search might return more than 500,000 data readings. In this case, you might use the ONE_WEEK aggregation interval to have the service aggregate the data readings on a weekly basis, and, as a result, return no more than 52 entries.
Set to
To aggregate the collected data
ONE_MINUTE
For each minute in the collection period.
FIVE_MINUTE
For each five minute interval in the collection period.
TEN_MINUTE
For each ten minute interval in the collection period.
FIFTEEN_MINUTE
For each fifteen minute interval in the collection period.
THIRTY_MINUTE
For each thirty minute interval in the collection period.
ONE_HOUR
For each one hour in the collection period.
TWO_HOUR
For each two hour interval in the collection period.
FOUR_HOUR
For each four hour interval in the collection period.
EIGHT_HOUR
For each eight hour interval in the collection period.
TWELVE_HOUR
For each twelve hour interval in the collection period.
ONE_DAY
For each one day in the collection period.
ONE_WEEK
For each one week in the collection period.
timePeriod
String Required when no startDate and endDate are provided. Defines the time period for which to return KPI instance readings. For example, if the current date is January 10, 2009 and you specify LAST_YEAR as time period, the service will return data only from January 1 to January 10, 2009.
Set to
To retrieve KPI instance readings from
LAST_HOUR
The current hour.
LAST_DAY
The current day.
LAST_WEEK
The current week.
LAST_MONTH
The current month.
LAST_QUARTER
The current quarter.
LAST_YEAR
The current year.
startDate
String Required when no timePeriod is provided. Specifies the start of the time period for which to retrieve KPI instance readings. The time must be in the following format: yyyy-MM-dd’T’HH:mm:ssZ.
endDate
String Required when no timePeriod is provided. Specifies the end of the time period for which to return KPI instance readings. The time must be in the following format: yyyy-MM-dd’T’HH:mm:ssZ.