GetRealTimeReport: Get Real-Time report

In randyzwitch/RSiteCatalyst: R Client for Adobe Analytics API V1.4

Description

Function to access the Adobe Analytics Real-Time API v1.4. This API provides the ability for reporting up to the most recent minute. This API is best used at 15-30 second intervals (or longer).

Usage

GetRealTimeReport(reportsuite.ids, metrics, elements = c(),
  date.granularity = 5, date.from = "1 hour ago", date.to = "now",
  sort.algorithm = "mostpopular", floor.sensitivity = 0.25,
  first.rank.period = 0, algorithm.argument = "linear",
  everything.else = TRUE, selected = c())

Arguments

reportsuite.ids	Report Suite
metrics	Report metric
elements	Report breakdowns
date.granularity	Report Granularity. Defaults to 5 minutes
date.from	Report starting time. Defaults to "1 hour ago"
date.to	Report end time. Defaults to "now"
sort.algorithm	Sorting algorithm. Defaults to "mostpopular"
floor.sensitivity	Floor sensitivity. Defaults to .25
first.rank.period	First Ranking Period. Defaults to 0
algorithm.argument	Ranking algorithm. Defaults to "linear"
everything.else	Provide counts for elements not returned as 'top'
selected	Selected items for a given element (only works for a single element)

Details

The Real-Time API uses a concept of "relative dates". To get a feeling for what's possible for submitting to date.from and date.to parameters, see link at:

http://php.net/manual/en/datetime.formats.relative.php

Value

Data frame

Examples

## Not run: 

custom_report <- GetRealTimeReport('')


## End(Not run)

randyzwitch/RSiteCatalyst documentation built on May 11, 2020, 3:05 p.m.