aw_get_segments | R Documentation |
Retrieve all segments
aw_get_segments( company_id = Sys.getenv("AW_COMPANY_ID"), rsids = NULL, segmentFilter = NULL, locale = "en_US", name = NULL, tagNames = NULL, filterByPublishedSegments = "all", limit = 10, page = 0, sortDirection = "ASC", sortProperty = "id", expansion = NULL, includeType = "all", debug = FALSE )
company_id |
Company ID. If an environment variable called |
rsids |
Filter the list to only include segments tied to a specified RSID or
list of RSIDs. Specify multiple RSIDs as a vector (i.e., " |
segmentFilter |
Filter list to only include suites in this list of segment IDs (comma-delimited) |
locale |
The locale that segment details should be returned in. The default is |
name |
Filter the list to only include segments that contain the specified name. This is case-insensitive and is a simple, single string match. |
tagNames |
Filter the list to only include segments that contain one of the tags. |
filterByPublishedSegments |
Filter the list to only include segments where the published field is set to one of the allowable values:
|
limit |
The number of results to return per page. This argument works in conjunction with the
|
page |
The "page" of results to display. This works in conjunction with the |
sortDirection |
The sort direction for the results: |
sortProperty |
The property to sort the results by. Currently available values are |
expansion |
Additional segment metadata fields to include in the results: |
includeType |
Include additional segments not owned by the user. Available values are |
debug |
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.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.