Interface IEventAnalyticsReportRequest
-
- All Known Implementing Classes:
EventAnalyticsDashboardRequest
,EventAnalyticsReportRequest
public interface IEventAnalyticsReportRequest
Event analytics report request.- Since:
- 11.0.0
- Version:
- $Revision$ $Date$
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EventFilterData
getEventFilter()
Returns the eventFilter.java.util.List<EventAnalyticsReportRequest.GroupByHolder>
getGroupBys()
Returns the groupBy list in this request.Tuple2<IAggregation,java.util.function.Function<java.lang.Object,java.lang.String>>
getInterval()
Returns the interval.java.util.Map<java.lang.String,Tuple2<IAggregation,java.lang.Boolean>>
getMetrics()
Returns the metrics.ServiceInstanceConfig
getServiceInstanceConfig()
Returns the serviceInstanceConfig.Tuple3<java.util.Date,java.util.Date,ISearchQueryFilter>
getTimeFrame()
Returns the timeFrame.UserSegmentationData
getUserSegmentation()
Returns the userSegmentation.boolean
isCompareValuesWithGreatestValue()
Returns whether the values must be compared with the greatest aggregation value.boolean
isExcludeAdminAreaAccess()
Returns whether values ââshould be counted excluding those within administrative areasboolean
isStandard()
Returns whether this is a standard report.
-
-
-
Method Detail
-
getMetrics
java.util.Map<java.lang.String,Tuple2<IAggregation,java.lang.Boolean>> getMetrics()
Returns the metrics. The value tuple contains ina
slot the metric aggregation and inb
slot, a flag to indicate whether the metric is for a user custom attribute.- Returns:
- the metrics
- Since:
- 11.0.0
-
getGroupBys
java.util.List<EventAnalyticsReportRequest.GroupByHolder> getGroupBys()
Returns the groupBy list in this request.- Returns:
- the groupBy list. Returns an empty list if there is no groupBy. Never returns
null
. - Since:
- 15.0.0
-
getEventFilter
EventFilterData getEventFilter()
Returns the eventFilter.- Returns:
- the eventFilter
- Since:
- 11.0.0
-
getInterval
Tuple2<IAggregation,java.util.function.Function<java.lang.Object,java.lang.String>> getInterval()
Returns the interval.- Returns:
- the interval
- Since:
- 11.0.0
-
getUserSegmentation
UserSegmentationData getUserSegmentation()
Returns the userSegmentation.- Returns:
- the userSegmentation
- Since:
- 11.0.0
-
getTimeFrame
Tuple3<java.util.Date,java.util.Date,ISearchQueryFilter> getTimeFrame()
Returns the timeFrame.- Returns:
- the timeFrame
- Since:
- 11.0.0
-
getServiceInstanceConfig
ServiceInstanceConfig getServiceInstanceConfig()
Returns the serviceInstanceConfig.- Returns:
- the serviceInstanceConfig
- Since:
- 11.0.0
-
isStandard
boolean isStandard()
Returns whether this is a standard report.- Returns:
- whether this is a standard report.
- Since:
- 11.0.0
-
isCompareValuesWithGreatestValue
boolean isCompareValuesWithGreatestValue()
Returns whether the values must be compared with the greatest aggregation value.- Returns:
- whether the values must be compared with the greatest aggregation value.
- Since:
- 14.2.0
-
isExcludeAdminAreaAccess
boolean isExcludeAdminAreaAccess()
Returns whether values ââshould be counted excluding those within administrative areas- Returns:
- whether values ââshould be counted excluding those within administrative areas
- Since:
- 17.0.0
-
-