Retrieve all tag names or search by component id or tag names
aw_get_tags(
company_id = Sys.getenv("AW_COMPANY_ID"),
componentId = NULL,
componentType = NULL,
tagNames = NULL,
limit = 1000,
page = 0,
debug = FALSE
)
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.
The component id being requested. Default is NULL
The component type being requested. Options include segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classification. Default is NULL
Comma separated vector of tag names. componentType
The number of results to return per page. This argument works in conjunction with the
page
argument. The default is 10.
The "page" of results to display. This works in conjunction with the limit
argument and is
zero-based. For instance, if limit = 20
and page = 1
, the results returned would be 21 through 40.
Include the output and input of the api call in the console for debugging. Default is FALSE
A data frame of tags and the associated meta data.