aw_get_dimensions {adobeanalyticsr}

Get list of dimensions

Description

This will generate an extensive list of all the dimensions in the reportsuite.

Usage

aw_get_dimensions(
  rsid = Sys.getenv("AW_REPORTSUITE_ID"),
  locale = "en_US",
  segmentable = FALSE,
  reportable = FALSE,
  classifiable = FALSE,
  expansion = NULL,
  debug = FALSE,
  company_id = Sys.getenv("AW_COMPANY_ID")
)

Arguments

rsid

Adobe report suite ID (RSID). If an environment variable called AW_REPORTSUITE_ID exists in .Renviron or elsewhere and no rsid argument is provided, then the AW_REPORTSUITE_ID value will be used. Use aw_get_reportsuites to get a list of available rsid values.

locale

The locale that dimension details should be returned in. The default is en_US.

segmentable

Boolean that determines whether or not to include dimensions that can be used in segments. FALSE (the default) returns all dimensions (not just the non-segmentable ones). Examples of dimensions that cannot be used in segments are clickmapaction, codeversion, newvisit, and pageurl.

reportable

Boolean that determines whether or not to include dimensions that can be used in reports FALSE (the default) returns all dimensions (not just the non-segmentable ones).

classifiable

Boolean that determines whether or not to include dimensions that can be used in classifications FALSE (the default) returns all dimensions (not just the non-segmentable ones).

expansion

Additional dimension metadata to include in the results: tags, allowedForReporting, and categories. This argument takes a single value (e.g., expansion = "tags") or a vector of values (e.g., expansion = c("tags", "categories")).

debug

Include the output and input of the api call in the console for debugging. Default is FALSE

company_id

Company ID. If an environment variable called AW_COMPANY_ID exists in .Renviron or elsewhere and no company_id argument is provided, then the AW_COMPANY_ID value will be used. Use get_me to get a list of available company_id values.

Value

A data frame of dimensions and their meta data.