Usage
GetRealTimeReport(report_suite, metrics, elements = c(), periodMinutes = 1,
periodCount = 15, periodOffset = 0, algorithm = "most popular",
algorithmArgument = "linear", firstRankPeriod = "0",
floorSensitivity = 0.25)
Arguments
report_suite
Report Suite ID
metrics
Metric to include in the Realtime report.
The metric must be configured previously using
SaveRealTimeConfiguration
elements
A list of elements that breaks down
(organizes) the metrics data in the report. Each element
must be configured previously using
SaveRealTimeConfiguration. If no elements are provided, an overtime report is
generated for the provided metric.
periodMinutes
Number of minutes for one period.
Default is 1.
periodCount
The number of periods of data to
return. Default is 15.
periodOffset
Number of minutes before the current
minute to run the report. If set to 10, the most recent
result will be from ten minutes prior to the request.
Default is 0.
algorithm
Type of dimensions to return, one of the
following three values: 'gainers', 'losers', 'most
popular'. Default is 'most popular'.
algorithmArgument
Specifies how to order the
values for Most Popular, Gainers or Losers. Specify
either percent, or linear. Default is linear.
firstRankPeriod
Computes the ranking of elements
by considering the element's counts from the
firstRankPeriod to the final period. With this argument
you can rank from the first period (0) to periodCount - 1
(most popular) or periodCount - 3 (gainers/losers) or
floorSensitivity
A factor between 0 and 1 that is
used to cut off low-count items from percentage ranking.
Relative only to gainers/losers by percent. Default is
.25.