Retrieve all segments
aw_get_segments( company_id = Sys.getenv("AW_COMPANY_ID"), rsids = NA, segmentFilter = NA, locale = "en_US", name = NA, tagNames = NA, filterByPublishedSegments = "all", limit = 10, page = 0, sortDirection = "ASC", sortProperty = "id", expansion = NA, includeType = "all", debug = FALSE )
Company ID. If an environment variable called
Filter the list to only include segments tied to a specified RSID or
list of RSIDs. Specify multiple RSIDs as a vector (i.e., "
Filter list to only include suites in this list of segment IDs (comma-delimited)
The locale that segment details should be returned in. The default is
Filter the list to only include segments that contain the specified name. This is case-insensitive and is a simple, single string match.
Filter the list to only include segments that contain one of the tags.
Filter the list to only include segments where the published field is set to one of the allowable values:
The number of results to return per page. This argument works in conjunction with the
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 segment metadata fields to include in the results:
Include additional segments not owned by the 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 segments and their meta data.