Получение отчетов

В Adfox есть предзаданные отчеты (далее — fixed), которые предоставляются платформой и доступны партнерам, а также есть возможность с помощью конструктора отчетов собрать и сохранить собственный отчет в интерфейсе (далее — custom).

Получение отчета состоит из нескольких шагов.

Если отчет сохранен — fixed или custom:

  1. Запросите список отчетов:

    GET /api/v2/reports/list
    
  2. Получите параметры отчетов (только для custom, для fixed список полей не вернет):

    GET /api/v2/reports/report-info/{reportName}
    
  3. Получите доступный период:

    GET /available-dates
    
  4. Отправьте запрос на формирование отчета и сохраните result.taskId:

    POST /api/v2/reports/{reportName}
    
  1. Получите и закэшируйте списки dimensions, metrics, filters и limits:

    GET /metadata
    
  2. При необходимости получите доступные даты для отчета:

    GET /available-dates
    
  3. Отправьте запрос с валидным телом и сохраните result.taskId:

    POST /reports
    

Далее:

  1. Выполняйте цикл запросов до получения одного из статусов:

    • SUCCESS
    • FAILURE
    • EXPIRED
    GET /reports/{taskId}
    
  2. Используйте таймаут перед повторным запросом.

  3. При статусе SUCCESS получите результат отчета:

    GET /reports/{taskId}/result