comagicR
Описание
Пакет для работы с API сервиса CoMagic
Языки
- R100%
месяц назад
12 дней назад
13 дней назад
месяц назад
месяц назад
месяц назад
месяц назад
13 дней назад
месяц назад
месяц назад
README.md
comagicR
comagicR — R-пакет для работы с Comagic Data API (JSON-RPC 2.0).
Позволяет выгружать обращения, список отчётов и доступные поля прямо в R в виде .data.table
Установка
Аутентификация
Рекомендуется хранить API-ключ в переменной окружения, а не передавать его явно в коде.
После сохранения перезапустите R-сессию. Функции пакета подхватят токен автоматически.
Альтернативно — передавайте токен через аргумент напрямую.access_token
Быстрый старт
Типичный рабочий процесс состоит из трёх шагов: получить список отчётов, узнать доступные поля, выгрузить данные.
Функции
| Функция | Описание |
|---|---|
| Возвращает таблицу с доступными отчётами (, и др.) |
| Возвращает список доступных мнемоник полей для указанного типа отчёта |
| Выгружает обращения за период с автопагинацией; вложенные объекты автоматически разворачиваются в плоские колонки |
Параметры get_report()
get_report()
| Параметр | Описание |
|---|---|
/ | Период выборки в формате , макс. интервал 366 дней |
/ | Идентификатор и тип отчёта из |
| Символьный вектор мнемоник полей. Если пуст — ответ будет пустым |
| Список-фильтр (необязательно), поддерживает операторы , , , , , |
| Список сортировки (необязательно) |
| Записей на страницу, макс. 10 000 (по умолч. 10 000) |
| Автоматически загружать все страницы? (по умолч. ) |
| API-ключ; если — берётся из |
| URL API; альтернатива: |
Зависимости
— HTTP-запросыhttr2— быстрая обработка табличных данныхdata.table— форматированные сообщения и ошибкиcli— утилиты для работы с Rrlang
Лицензия
MIT © Alexandr Korshakov