rmixpanel

R клиент для работы с API Mixpanel (Загрузка данных из Mixpanel в R)

Project maintained by selesnow Hosted on GitHub Pages — Theme by mattgraham

Menu:


Search:


Выберите язык описания пакета | Chose language of package description
English
Русский

Содержание ReadMe пакета rmixpanel

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

Пакет rmixpanel является R клиентом для работы с API веб аналитической платформы Mixpanel, предназначем для максимально удобной загрузки данных из API mixpanel в R.

Для удобства быстрого поиска функций пакета, название всех доступных функций имеет префик “MP.”.

Подробную справку с описанием всех аргументов и примером работы по каждой из функций можно получить выполнив команду help . Например что бы получить справку по функции MP.getRawData запустите в R следующую команду.

help("MP.getRawData")

Для того, что бы получить список всех функций и ссылки на справку по каждой из фунцйи воспользуйтесь следующей командой. help(package = "rmixpanel")

Установка пакета rmixpanel

Установить пакет можно непосредственно из репозитония на GitHub, для этого достаточно запустить в R консоли приведённый ниже код.

if(!"rmixpanel" %in% installed.packages()[,1]){install.packages("devtools")}
devtools::install_github("selesnow/rmixpanel")

Как получить api_secret для работы с API mixpanel

Обязательным аргументом каждой функции пакета mixpanel является api_secret, найти его можно в веб интерфейсе платформы MixPanel следующим образом.

  1. Заходим в свою учётную запись mixpanel используя свой логин и пароль.
  2. В основном выпадающем меню выбираем пункт “Accounts”.
  3. В открывшемся диалоговом окне открываем вкладку “Projects”, и копируем API Secret нужного проекта.

    Функции пакета rmixpanel

НазваниеОписание
MP.getEventsПолучить количество разичных событий по дням.
MP.getEventsPropertyПолучит количество события в разреще одного свойства по дням.
MP.getRetentionПолучить выгрузку сырых данных из Mixpanel.
MP.getRawDataПолучить когортный анализ.

MP.getEvents - Получить количество разичных событий по дням.

Аргументы

Пример использования

Получить общее количество событий “posting_success”,”emu”,”session_start”,”$custom_event:585946” с 1 июля 2017 года по 25 июля 2017 года, с группировкой по дням.

MP_events_day <- MP.getEvents(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                              event = c("posting_success","emu","session_start","$custom_event:585946"),
                              type = "general",
                              unit = "day",
                              from_date = "2017-07-01",
                              to_date = "2017-07-25")

Получить среднее количество событий “session_start” и “$custom_event:585946” за последние 2 месяца, с группировкой по месяцам.

MP_events_month <- MP.getEvents(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                                event = c("session_start","$custom_event:585946"),
                                interval = 2,
                                type = "average",
                                unit = "month")

MP.getEventsProperty - Получит количество события в разреще одного свойства по дням.

Аргументы

Пример использования

Получить общее количество событий “$custom_event:585946” с 1 июля 2017 года по 25 июля 2017 года, с группировкой по дням и свойству mp_country_code.

MP_event_prop <- MP.getEventsProperty(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                                      event = c("$custom_event:585946"),
                                      property = "mp_country_code",
                                      type = "general",
                                      unit = "day",
                                      from_date = "2017-07-01",
                                      to_date = "2017-07-25")

Получить общее количество событий “$custom_event:585946” за текущий и предыдущий месяц, с группировкой по месяцам и свойству mp_country_code.

MP_event_prop_month <- MP.getEventsProperty(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                                            event = c("$custom_event:585946"),
                                            property = "mp_country_code",
                                            type = "general",
                                            interval = 2,
                                            unit = "month")

MP.getRetention - Получит когортный анализ.

Аргументы

Пример использования

Получить общее количество событий “$custom_event:585946” с 1 июля 2017 года по 25 июля 2017 года, с группировкой по дням и свойству mp_country_code.

retension <- MP.getRetention(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                             event = "emu",
                             retention_type = "birth",
                             unit = "week",
                             born_event = "session_start",
                             where = 'properties["utm_source"]=="AdWords" and "Brand" in properties["utm_campaign"]',
                             interval_count = 4,
                             from_date = "2017-08-01",
                             to_date = "2017-09-25")

Получить когортный анализ по неделям, за 4 недели начиная с 1 августа 2017 года, разбив когорты по источнику, свойство utm_source.

retension_property <- MP.getRetention(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                                      event = "emu",
                                      retention_type = "birth",
                                      unit = "week",
                                      born_event = "session_start",
                                      on = 'properties["utm_source"]',
                                      interval_count = 4,
                                      from_date = "2017-08-01",
                                      to_date = "2017-09-25")

MP.getRawData - Получит сырые данные из API Mixpanel.

Данная функция работает достаточно долго, при большом объёме событий в аккаунте их обработка может занимать часы, в связи с чем рекомендуется использовать выгрузку сырых данных тольво в тех случаях когда получить необходимый набор данных с помощью других функций невозможно.

Аргументы

Пример использования

Получить выгрузку событий emu и ивсех его свойтв за 10 июля 2017 года, только по источнику AdWords, и рекламным кампаниям в названии которых содержится Brand.

MixPanel.RawData <- MP.getRawData(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                                  event = "emu",
                                  where = 'properties["utm_source"]=="AdWords" and "Brand" in properties["utm_campaign"]',
                                  from_date = "2017-07-10",
                                  to_date = "2017-07-10")

Получить выгрузку всех событий со всеми свойствами с 1 сентября 2017 года по 10 сентября 2017 года. **Обработка такого запроса может продолжаться несколько часов, и более.

MixPanel.RawData <- MP.getRawData(api_secret = "hgf7fi437nhdsad7863y98ryn988h8",
                                  from_date = "2017-09-01",
                                  to_date = "2017-09-10")

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

Контакты
email: selesnow@gmail.com
skype: selesnow
telegram: @AlexeySeleznev
Facebook Vkontakte Linkedin Blog GitHub Stepic