Формирование отчета

Как сформировать отчет

1. Для авторизации в API Статистики используйте токен, который вы получили для API Adfox. Если у вас еще нет токена, получите его.

2. В HTTP-заголовке Authorization передавайте полученный OAuth-токен при каждом запросе.

   curl -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037' https://adfox.yandex.ru/api/report/list/owner
   

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

4. Выполните запрос на формирование отчета. Одновременно в работе могут находиться не больше 3 отчетов.

5. Выполните запрос на получение готового отчета. Если отчет еще не готов, в ответе вы получите соответствующий статус.

Уровень детализации

Доступные уровни детализации:

• owner — общий отчет;
• supercampaign — на уровне суперкампании;
• campaign — на уровне кампании;
• banner — на уровне баннера;
• site — на уровне сайта;
• section — на уровне раздела;
• place — на уровне рекламного места.

Аргументы для построения отчета

Ниже перечислены все возможные аргументы для построения отчетов. В зависимости от выбранного отчета, в запросе потребуется передать определенный набор аргументов. Чтобы узнать, какие из аргументы потребуются для выбранного отчета, используйте метод.

• supercampaignId — ID суперкампании;
• campaignId — ID кампании;
• bannerId — ID баннера;
• siteId — ID сайта;
• sectionId — ID раздела;
• placeId — ID рекламного места;
• categoryId — ID категории;
• criteriaId — ID пользовательской метрики;
• criteria2Id — ID пользовательской метрики;
• name — название отчета;
• dateFrom — начальная дата отчетного периода, YYYY-MM-DD;
• dateTo — конечная дата отчетного периода, YYYY-MM-DD;
• day — день, отчет за который необходимо представить, YYYY-MM-DD;
• ownerId — ID владельца аккаунта. Аргумент доступен только для владельцев площадок и рекламодателей.