Запрос на создание отчёта

Создайте запрос на формирование отчёта в CSV или XLSX файле.

Входные данные

POST https://tracker.my.com/api/report/v1/file/create.json

Параметры

Если вы передаёте несколько значений в фильтре, то используйте квадратные скобки перед списком значений 'idApp[]': [1, 2, 3] или записывайте значения через запятую 'idApp': '1,2,3'.

* — обязательные параметры

Примеры запроса

Для предотвращения ошибок в отчёте, рекомендуем завершать каждый запрос следующим набором селекторов (значения приведены для примера):

&settings[idCurrency]=643&settings[tz]=Europe%2FMoscow&settings[precision]=2&settings[retIndent]=3600

Фильтр по датам

Отчёт за период с 10-07-2020 по 17-10-2020 по числу установок countInstall по приложениям idApp .

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,countInstall&settings[idCurrency]=643&settings[tz]=Europe%2FMoscow&settings[precision]=2&settings[retIndent]=3600

Фильтр по приложениям

Отчёт за период с 10-07-2020 по 17-10-2020 по числу установок countInstall по приложениям idApp: 1234 и 431 .

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,countInstall&settings[filter][dimension][idApp][value][]=1234&settings[filter][dimension][idApp][value][]=4311&settings[idCurrency]=643&settings[tz]=Europe%2FMoscow&settings[precision]=2&settings[retIndent]=3600

Группировка по приложениям

Отчёт за период с 10-07-2020 по 17-10-2020 по числу установок countInstall по приложениям idApp и проектам idProject с группировкой по приложениям.

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,idProject,countInstall&settings[groupBy]=idApp&settings[idCurrency]=643&settings[tz]=Europe%2FMoscow&settings[precision]=2&settings[retIndent]=3600

Фильтр по параметрам событий

Отчёт за период с 10-07-2020 по 17-10-2020 по числу установок countInstall и кастомных событий eventName по приложениям idApp с фильтром по параметрам name1=val1 и name2>22 с целевым показателем событие [target]=events. Подробнее о фильтре по параметрам

settings[filter][date][from]=2020-07-10&settings[filter][date][to]=2020-07-17&settings[selectors]=idApp,countInstall&settings[filter][dimension][params][name][]=name1&settings[filter][dimension][params][cmp][]=equals&settings[filter][dimension][params][value][]=val1&settings[filter][dimension][params][name][]=name2&settings[filter][dimension][params][cmp][]=>&settings[filter][dimension][params][value][]=22&settings[filter][dimension][params][target]=events&settings[filter][dimension][params][join]=and&settings[idCurrency]=643&settings[tz]=Europe%2FMoscow&settings[precision]=2&settings[retIndent]=3600

Фильтр по версии приложения

Отчёт с фильтром по версиям приложений равным 1.2 и 3.4.5.

settings[filter][dimension][appVersion][operator][]=%3D&settings[filter][dimension][appVersion][major][]=1&settings[filter][dimension][appVersion][minor][]=2&settings[filter][dimension][appVersion][patch][]=&settings[filter][dimension][appVersion][operator][]=%3D&settings[filter][dimension][appVersion][major][]=3&settings[filter][dimension][appVersion][minor][]=4&settings[filter][dimension][appVersion][patch][]=5&settings[idCurrency]=643&settings[tz]=Europe%2FMoscow&settings[precision]=2&settings[retIndent]=3600

Форматы ответа

В случае успеха

Если запрос создан успешно, вы получите код ответа 200. Идентификатор запроса будет указан в поле idReportFile:

{
  "code": 200,
  "message": "Ok",
  "data": {
    "idReportFile": "2"
  }
}

Ошибки

При ошибках в передаваемых параметрах вы получите код ответа 400. Например:

• Неправильно передан тип выгружаемого файла — fileType

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Argument 'fileType' must be in set of file types. Allowed values are: xlsx, csv."
      }
    }
  }

• Не передан обязательный параметр

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Argument 'settings' is expected but not set"
      }
    }
  }

• Запрос недоступного или несуществующего селектора.

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Argument 'settings[selectors]' is invalid"
      }
    }
  }

Ограничения

• Данный метод требует авторизации. Вы получите код ответа 403, если сделаете запрос с невалидной авторизацией или не передадите её совсем.

  {
    "code": 403,
    "message": "Access denied",
    "data": null
  }

• Количество одновременно выполняемых запросов ограничено. При превышении допустимого числа запросов вы получите код ответа 400:

  {
    "code": 400,
    "message": "Bad Request",
    "data": {
      "error": {
        "detail": "Maximum number of simultaneous requests reached. Wait until there is space available in the queue.",
         "info": {
          "reportFiles": [
            {
              "idReportFile": "2"
            }
          ]
        }
      }
    }
  }