💡 Если вы в процессе освобождения себя от огромного количества электронных таблиц или у вас уже есть разработанная система аналитики, вы можете воспользоваться нашим API, чтобы автоматически выгружать нужные данные без необходимости импортировать CSV файл снова и снова.
💡 Обратите внимание, что наш API поддерживает только GET метод. Это означает, что вы не сможете удалить / добавить домены или рекламные форматы через API.
Получение API токена
Ограничение частоты запросов — 1200 запросов в минуту на пользователя. Каждый ответ API также кэшируется на 60 секунд.
Чтобы получить API token, зайдите на страницу Settings (вкладка API) в меню слева и нажмите на "Generate new token":
❗ Обратите внимание: токен можно просмотреть и скопировать только в момент его создания. После этого доступ к нему будет невозможен.
На странице API вы также можете увидеть:
Количество активных токенов — одновременно можно иметь до 5 активных API-токенов;
Ссылку на документацию API;
Информацию обо всех активных токенах, включая:
Название;
Статус;
Дату истечения срока действия (каждый токен действует 1 год);
Дату создания;
Дату и время последнего использования;
IP-адрес;
Страну;
Возможность переименовать или удалить каждый отдельный токен
Вы получите уведомление по электронной почте, когда срок действия одного из ваших токенов будет подходить к концу.
Установите токен в этот параметр заголовка под названием x-api-key:
Доступные endpoints и URI
Все запросы создаются через следующий URI:
<https://api3.adsterratools.com/publisher/>
Ниже вы найдете список доступных конечных точек:
/domains/{format}— возвращает сайты, добавленные в аккаунт Adsterra, включая их названия и уникальные ID;/domain/{domain_id}/placements.{format}— ваши форматы на конкретном домене; обратите внимание, что вам понадобится domain_id, полученный из запроса/domains/{format}, сначала;/placements.{format}— возвращает полный список ваших рекламных форматов;/stats.{format}— отчет, включающий в себя показы, клики, CTR, CPM и доход, сортированные по дате; вы можете указать domain_id, placement_id, начальную и конечную дату, а также определенный гео.
Данные можно выгрузить в формате JSON, XML и CSV. Пожалуйста, убедитесь, что вы указали требуемый формат в URI:
<https://api3.adsterratools.com/publisher/domains.json>
Примеры запросов на получение статистики Adsterra через API
Мы рассмотрим несколько запросов, полученных с помощью Postman — популярного инструмента для тестирования API. Вы можете воспользоваться им, чтобы получить представление о том, как выглядят наши данные, и протестировать запросы, которые вы планируете создавать.
Для начала нам нужно получить ID доменов через следующий URI:
<https://api3.adsterratools.com/publisher/cd5b79b8571721afd21bbbc1fa0f299b/domains.json>
В теле ответа мы видим следующее:
Давайте найдем ID рекламных форматов для первого сайта (domain_id 1385226):
Теперь мы можем использовать domain_id и placement_id, чтобы выгрузить статистику по данному формату:
Ответ:
Возможные ошибки и способы их устранения
401 — неверный токен. Попробуйте использовать токен, доступный в вашем личном кабинете.
403 — токен более не действителен. Сгенерируйте новый токен.
404 — not found. Убедитесь, что URI корректен.