rym v1.0.3

0

Monthly downloads

0th

Percentile

R Interface to Yandex Metrica API

Allows work with 'Management API' for load counters, segments, filters, user permissions and goals list from Yandex Metrica, 'Reporting API' allows you to get information about the statistics of site visits and other data without using the web interface, 'Logs API' allows to receive non-aggregated data and 'Compatible with Google Analytics Core Reporting API v3' allows receive information about site traffic and other data using field names from Google Analytics Core API. For more information see official documents <https://tech.yandex.ru/metrika/doc/api2/concept/about-docpage/>.

Readme

rym - R пакет для работы с API Яндекс.Метрики

===

CRAN

Rdoc

Официальная документация к пакету rym

Официальную русскоязычную документацию можно найти по этой ссылке

Краткое описание

================

rym является R интерфейсом для работы с API Яндекс Метрики, его функции позволяют вам взаимодействовать со следующими API:

  1. API Управления - позволяет получить таблицы с такими объектами как достуные счётчики Яндекс.Метрики, список настроенных целей, фильтров и сегментов, а так же список пользователей у которых есть доступ к счётчику.
  2. API Отчётов - позволяет получать информацию о статистике посещений сайта и другие данные, не используя интерфейс Яндекс.Метрики.
  3. API совместимый с Core API Google Analytics (v3) - позволяет запрашивать статистические данные используя при этом название полей такие же как и при работе с Core Reporting API v3.
  4. Logs API - позволяет получить сырые, несгруппированные данные о посещении вашего сайта из Яндекс.Метрики.

Установка


Установить rym можно как с CRAN так и с GitHub

CRAN: install.packages('rym')

GitHub: devtools::install_github("selesnow/rym")

Виньетки

========

Помимо официальной документации у пакета есть 5 виньеток, вводная, и отдельно виньетка под каждый API, открыть их можно с помощью следующих команд:

  • Введение в пакет rym: vignette('intro-to-rym', package = 'rym')
  • API Управления: vignette('rym-management-api', package = 'rym')
  • API Отчётов: vignette('rym-reporting-api', package = 'rym')
  • API совместимый с Core API Google Analytics v3: vignette('rym-ga-api', package = 'rym')
  • Logs API: vignette('rym-logs-api', package = 'rym')

Пример кода

# auth
rym_auth(login = "vipman.netpeak", token.path = "metrica_token")
rym_auth(login = "selesnow", token.path = "metrica_token")


# ManagementAPI
# get counters list
selesnow.counters <- rym_get_counters(login      = "selesnow",
                                      token.path = "metrica_token")

vipman.counters   <- rym_get_counters(login      = "vipman.netpeak",
                                      token.path = "metrica_token")

# get goals list
my_goals <- rym_get_goals(counter = 10595804,
                          login      = "vipman.netpeak",
                          token.path = "metrica_token")

# пget filter list
my_filter <- rym_get_filters(counter = 10595804,
                             login      = "vipman.netpeak",
                             token.path = "metrica_token")

# get segment list
my_segments <- rym_get_segments(counter = 10595804,
                                login      = "vipman.netpeak",
                                token.path = "metrica_token")

# get counter list
users <- rym_users_grants(counter = 10595804,
                          login      = "vipman.netpeak",
                          token.path = "metrica_token")

# Reporting API
reporting.api.stat <- rym_get_data(counters   = "23660530,10595804",
                                   date.from  = "2018-08-01",
                                   date.to    = "yesterday",
                                   dimensions = "ym:s:date,ym:s:lastTrafficSource",
                                   metrics    = "ym:s:visits,ym:s:pageviews,ym:s:users",
                                   sort       = "-ym:s:date",
                                   login      = "vipman.netpeak",
                                   token.path = "metrica_token",
                                   lang = "en")

# Logs API
logs.api.stat      <- rym_get_logs(counter    = 23660530,
                                   date.from  = "2018-08-01",
                                   date.to    = "2018-08-05",
                                   fields     = "ym:s:date,
                                                 ym:s:lastTrafficSource,
                                                 ym:s:referer",
                                   source     = "visits",
                                   login      = "vipman.netpeak",
                                   token.path = "metrica_token")

# API compatible with Core API Google Analytics v3
ga.api.stat        <- rym_get_ga(counter    = "ga:22584910",
                                 dimensions = "ga:date,ga:source",
                                 metrics    = "ga:sessions,ga:users",
                                 start.date = "2018-08-01",
                                 end.date   = "2018-08-05",
                                 sort       = "-ga:date",
                                 login      = "selesnow",
                                 token.path = "metrica_token")

Статьи:

Видео уроки:

Автор: Алексей Селезнёв (Head of Analytics Dept. at Netpeak)

Functions in rym

Name Description
rym_get_data Load data by compatible with the 'Google Analytics Core Reporting API'
rym-package rym
rym_auth Authentication in Yandex Metrika API
rym-offline-conversion Manage offline conversions
rym_get_direct_clients Load Yandex.Direct clients
rym_add_segment Create segment in 'Yandex Metrica'
rym_add_goal Create goal in 'Yandex Metrica'
rym-expense-uploading Manage Cost Data Upload
rym-calls Manage callss
rym_get_counters Load Yandex Metrica counters
rym_get_goals List of goals
rym_users_grants List of users permissions
rym_get_logs Get raw data from yandex metrika.
rym_get_segments List of segments
rym_get_my_logins Show list of auth logins
rym_get_filters List of filters
rym_get_ga Work with 'compatible with the Google Analytics Core Reporting API (v3)'
No Results!

Vignettes of rym

Name
intro-to-rym.Rmd
rym-calls.Rmd
rym-ga-api.Rmd
rym-load-expense.Rmd
rym-load-offline-conversion.Rmd
rym-logs-api.Rmd
rym-management-api.Rmd
rym-reporting-api.Rmd
No Results!

Last month downloads

Details

Type Package
Date 2020-08-12
BugReports https://github.com/selesnow/rym/issues
VignetteBuilder knitr
License GPL-2
URL https://selesnow.github.io/rym/
Encoding UTF-8
Language ru
NeedsCompilation no
Packaged 2020-08-12 16:05:46 UTC; Alsey
Repository CRAN
Date/Publication 2020-08-12 16:20:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/rym)](http://www.rdocumentation.org/packages/rym)