Retrieve a list of available calculated metrics. The results will always include these default items:
type. Other attributes can
be optionally requested through the
aw_get_calculatedmetrics( company_id = Sys.getenv("AW_COMPANY_ID"), rsids = NA, ownerId = NA, filterByIds = NA, toBeUsedInRsid = NA, locale = "en_US", name = NA, tagNames = NA, favorite = NA, approved = NA, limit = 1000, page = 0, sortDirection = "DESC", sortProperty = NA, expansion = NA, includeType = "all", debug = FALSE )
Company ID. If an environment variable called
Filter the list to only include calculated metrics tied to a specified RSID or
list of RSIDs. Specify multiple RSIDs as a vector (i.e., "
Filter the list to only include calculated metrics owned by the specified loginId.
Filter the list to only include calculated metrics in the specified list as specified by a single string or as a vector of strings.
The report suite where the calculated metric is intended to be used. This
report suite is used to determine things like compatibility and permissions. If it is not specified,
then the permissions will be calculated based on the union of all metrics authorized in all groups
the user belongs to. If compatibility is specified for
The locale that system-named metrics should be returned in. Non-localized values will be returned for title, name, description, etc. if a localized value is not available.
Filter the list to only include calculated metrics that contain the specified name. This is case-insensitive and is a simple, single string match.
Filter the list to only include calculated metrics that contain one of the tags as specified by a single string or vector of strings.
The number of results to return per page. The default is 1,000.
The "page" of results to display. This works in conjunction with the
The sort direction for the results:
The property to sort the results by. Currently available values are
Additional calculated metric metadata fields to include in the results:
Include additional calculated metrics not owned by user. Available values are
Include the output and input of the api call in the console for debugging. Default is FALSE
A data frame of calculated metrics and their metadata.
This function is useful/needed to identify the specific ID of a calculated metric for use in other
expansion argument accepts the following values, which will then include additional columns
in the results:
owner.login columns to the results (
already included by default).
modified: adds a
modified column to the output with the date (ISO 8601 format) each
calculated metric was last modified.
definition: adds multiple columns (the number will vary based on the number and complexity of calculated metrics returns) that provide the actual formula for each of the calculated metrics. This is returned from the API as a JSON object and converted into columns by the function, which means it is pretty messy, so, really, it's not recommended that you use this value.
compatability: should add a column with the products that the metric is compatible with, but this behavior has not actually been shown to be true, so this may actually do nothing if included.
reportSuiteName: adds a
reportSuiteName and a
siteTitle column with the friendly report
suite name for the RSID.
tags: adds a column with an embedded data frame with all of the existing tags that are associated with the calculated metric. This can be a bit messy to work with, but the information is, at least, there.
Multiple values for
expansion can be included in the argument as a vector. For instance,
expansion = c("tags", "modified") will add both a
tags column and a
modified column to the output.