Поделиться через


Интерфейсы API для доступа к данным аналитики коммерческой платформы marketplace

Ниже приведен список интерфейсов API для доступа к данным аналитики коммерческой платформы и связанных с ними функциональных возможностей:

API-интерфейсы извлечения набора данных;

Таблица 1. API-интерфейсы извлечения набора данных

API Функциональность
Получение всех наборов данных Этот API должен вызываться для получения списка доступных наборов данных и соответствующих столбцов, метрик и диапазонов времени.

API-интерфейсы управления запросами;

Таблица 2. API-интерфейсы управления запросами

API Функциональность
Создание запроса отчета Этот API должен использоваться для создания запроса в случае использования.
Получение запросов отчетов Этот API должен использоваться для получения списка запросов.
Удаление запросов отчетов Этот API должен использоваться для удаления любого определяемого пользователем запроса.
Пробное выполнение запросов отчетов Этот API должен использоваться для проверки запроса и проверки данных.

API-интерфейсы управления отчетами;

Таблица 3. API-интерфейсы управления отчетами

API Функциональность
Создание отчета Этот API должен использоваться для создания или планирования отчета на основе идентификатора запроса.
Получение отчета Этот API должен использоваться для получения списка созданных отчетов.
Обновление отчета Этот API должен использоваться для изменения параметра отчета.
Удаление отчета Этот API должен использоваться для удаления любого отчета и соответствующих записей выполнения.
Приостановка выполнения отчетов Этот API должен использоваться для приостановки запланированного выполнения отчетов.
Возобновление выполнения отчетов Этот API должен использоваться для возобновления запланированного выполнения приостановленного отчета.

API-интерфейсы извлечения сведений о выполнении отчета.

Таблица 4. API-интерфейсы извлечения сведений о выполнении отчета

API Функциональность
Получение сведений о выполнении отчета Этот API должен использоваться для получения всех выполнений отчета.

Вы можете поработать с API-интерфейсами с помощью URL-адреса API Swagger.