GetMetrics: Get Available Metrics within a Report Suite

Description Usage Arguments Details Value Examples

View source: R/GetMetrics.R

Description

Gets valid metrics for current user, valid with optionally specified existing metrics, elements and date granularity

Usage

1
2
GetMetrics(reportsuite.ids, metrics = c(), elements = c(),
  date.granularity = "", report.type = "")

Arguments

reportsuite.ids

Single report suite id, or character vector of report suite ids

metrics

List of existing metrics you want to use in combination with an additional metric

elements

List of existing elements you want to use in combination with an additional metric

date.granularity

Granularity that you want to combine with an additional metric

report.type

If set to 'warehouse', the elements and metrics returned to use in combination with an addional element are supported in data warehouse reports.

Details

This function requires having a character vector with one or more valid Report Suites specified.

Value

Data frame

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
metrics.valid <- GetMetrics("your_report_suite",
                            metrics=c('visitors','pageviews'),
                            elements=c('page','geoCountry'),
                            date.granularity='day',
                            report.type=''))

metrics <- GetMetrics(report_suites$rsid)

## End(Not run)

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