comagicR

0

Описание

Пакет для работы с API сервиса CoMagic

Языки

  • R100%
README.md

comagicR

GitVerse CI

comagicR — R-пакет для работы с Comagic Data API (JSON-RPC 2.0).
Позволяет выгружать обращения, список отчётов и доступные поля прямо в R в виде

data.table
.

Установка

Аутентификация

Рекомендуется хранить API-ключ в переменной окружения, а не передавать его явно в коде.

После сохранения перезапустите R-сессию. Функции пакета подхватят токен автоматически.
Альтернативно — передавайте токен через аргумент

access_token
напрямую.

Быстрый старт

Типичный рабочий процесс состоит из трёх шагов: получить список отчётов, узнать доступные поля, выгрузить данные.

Функции

ФункцияОписание
get_reports_list()
Возвращает таблицу с доступными отчётами (
report_id
,
report_type
и др.)
get_columns_tree(report_type)
Возвращает список доступных мнемоник полей для указанного типа отчёта
get_report(...)
Выгружает обращения за период с автопагинацией; вложенные объекты автоматически разворачиваются в плоские колонки

Параметры
get_report()

ПараметрОписание
date_from
/
date_till
Период выборки в формате
"YYYY-MM-DD hh:mm:ss"
, макс. интервал 366 дней
report_id
/
report_type
Идентификатор и тип отчёта из
get_reports_list()
fields
Символьный вектор мнемоник полей. Если пуст — ответ будет пустым
filter
Список-фильтр (необязательно), поддерживает операторы
=
,
!=
,
<
,
>
,
like
,
in
sort
Список сортировки (необязательно)
limit
Записей на страницу, макс. 10 000 (по умолч. 10 000)
auto_paginate
Автоматически загружать все страницы? (по умолч.
TRUE
)
access_token
API-ключ; если
NULL
— берётся из
COMAGIC_ACCESS_TOKEN
base_url
URL API; альтернатива:
"https://dataapi.uiscom.ru/v2.0"

Зависимости

  • httr2
    — HTTP-запросы
  • data.table
    — быстрая обработка табличных данных
  • cli
    — форматированные сообщения и ошибки
  • rlang
    — утилиты для работы с R

Лицензия

MIT © Alexandr Korshakov