GetSegments: Get Segments Defined within a Report Suite

Description Usage Arguments Details Value Examples

View source: R/GetSegments.R

Description

Get a data frame of segments for the specified report suites. Useful to find segment IDs for use in reporting helper functions or JSON report definitions.

Usage

1
GetSegments(reportsuite.ids)

Arguments

reportsuite.ids

Report suite id (or list of report suite ids)

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
## Not run: 
segments <- GetSegments("your_report_suite")

segments2 <- GetSegments(report_suites$rsid)

## End(Not run)

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