rym (version 1.0.6)

rym_get_segments: 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"))

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.

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

Author

Alexey Seleznev

References

Official docs of Yandex Metrica Management API

Docs on rym website

Run vignette("rym-management-api", package = "rym") to see the corresponding vignette.

Examples

if (FALSE) {
segments <- rym_get_segments(counter    = "your_counter_id",
                             login      = "your_login")
}