rym_get_segments {rym} | R Documentation |
List of segments
Description
Returns a list of segments created using the API and related to the specified counter.
Usage
rym_get_segments(counter, login = getOption("rym.user"),
token.path = getOption("rym.token_path"))
Arguments
counter |
Yandex Metrika counter ID, you can get ids of all your conters over rym_counters |
login |
character, Your Yandex login |
token.path |
character, Directory for store API credential, by default is your work directory |
Value
Data frame with list of yandex metrica counter segments
id |
Segment id. |
counter_id |
Yandex Metrica counter id. |
name |
Segment name. |
expression |
An expression that matches the value of the filters parameter. |
is_retargeting |
Logical, is retargeting segment or not. |
segment_source |
Source of the segment. Indicates how to create it. Accepts the value of api - segments that are created using the API are used. |
Author(s)
Alexey Seleznev
References
Official docs of Yandex Metrica Management API
Run vignette("rym-management-api", package = "rym")
to see the corresponding vignette.
Examples
## Not run:
segments <- rym_get_segments(counter = "your_counter_id",
login = "your_login")
## End(Not run)