Перейти к содержимому

Обзор API

API mybi connect — способ получить статистику сервиса в машиночитаемом виде: расход строк, задания и их запуски, загрузки данных, события журнала, счета и платежи. Ответы можно собирать в собственные отчеты и сверять их с данными личного кабинета.

Авторизация

В каждый запрос передаётся ключ доступа в параметре token. Ключ находится в настройках аккаунта → вкладка API. Ключ индивидуален: API возвращает только те данные, к которым у вас есть доступ в личном кабинете.

Базовый адрес

https://app.mybi.ru/api/v2/ + метод, например https://app.mybi.ru/api/v2/sources?token=ВАШ_КЛЮЧ

Форматы и ограничения

  • Даты в параметрах — YYYY-MM-DD HH:MM:SS (например, 2026-01-01 00:00:00).
  • Списки постраничные: page с 1, length по умолчанию 100 (максимум 500); в ответе объект pagination (см. схему).
  • Несколько значений фильтра (id, project_id, dimensions, metrics) передаются через запятую.

Коды ответов

400 — неверные параметры; 401 — ключ не передан или неверен; 403 — нет прав на операцию; 404 — запись не найдена; 422 — операцию выполнить не удалось.

Словарь

  • Проект — рабочее пространство с базой данных.
  • Источник — подключенный к проекту источник данных.
  • Аккаунт — учетная запись в сервисе-источнике, к которой привязан источник.
  • Задание — расписание автоматической выгрузки; Запуск — отдельное выполнение задания.
  • Загрузка — перенос строк из источника в базу проекта (в справке этот процесс также называют выгрузкой).

Информация

  • Версия OpenAPI: 3.0.0

Тип схемы безопасности: apiKey

Имя параметра (запроса): token