Обзор

Базовый URL: https://datahub-api.garpun.com (opens in a new tab)

Получение списков справочников, статистических отчетов и контента настроенных потоков данных. Это API будет вам необходимо, если вы являетесь интеграционным партнером Garpun.

API спроектировано для потоковой обработки данных и поэтому не возвращает классический JSON. Вместо этого, есть JSON_NEWLINE (opens in a new tab), по сути это - json объекты, разделенные переносом строки так, что каждая строка данных оказывается на новой строке выходного потока данных.

Пример обращения в API

Для синхронизации данных со своей БД

Получение данных SQL-like запросом. Используется язык запросов METAQL. Данные из этого источника могут возвращаться только в формате JSON_NEWLINE (opens in a new tab).

Используйте этот метод для синхронизации данных.

curl --compressed -v -N -X POST \
   -d '{"query":"select id, name from meta.dynamic_date_range"}'\
   -H "Content-Type:application/json" \
   "https://datahub-api.garpun.com/v1/metaql/query"

Некоторые данные хранятся специальным образом и для них нужно передавать shardKey. В документации в конкретным данным будет указано как именно можно получить shardKey.

curl --compressed -v -N -X POST \
   -d '{"shardKey": "42", "query":"SELECT id, virtual_ad_group_id, remote_id FROM garpun_storage.ad_group WHERE modification_time < '2020-01-01 00:00:00'"}' \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer XXXXXXXXXXXX" \
   "https://datahub-api.garpun.com/v1/metaql/query"

Для интеграции с Garpun Feeds

Формат возвращаемых данных может настраиваться.

Получение данных фида

curl --compressed -v -N -X POST \
   -H "Content-Type:application/json" \
   "https://datahub-api.garpun.com/v1/feeds/feed_data/{feed_key}?format=csv&from=2020-01-01&to=2020-01-10"

Получение схемы фида

curl --compressed -v -N -X POST \
   -H "Content-Type:application/json" \
   "https://datahub-api.garpun.com/v1/feeds/feed_schema/{feed_key}"

Библиотеки

Для аналитиков существует python-библиотека (opens in a new tab)

А так же посмотрите другие варианты работы с API используя библиотеки от Google

Описание ошибок

Ошибки обрабатываются стандартным образом - подробнее про обработку ошибок