&settings[idCurrency]=643&settings[tz]=Europe%2FMoscow&settings[precision]=2&settings[retIndent]=3600
Создайте запрос на формирование отчёта в CSV или XLSX файле.
POST https://tracker.my.com/api/report/v1/file/create.json
Если вы передаёте несколько значений в фильтре, то используйте квадратные скобки перед списком значений 'idApp[]': [1, 2, 3]
или записывайте значения через запятую 'idApp': '1,2,3'
.
Название | Значение | Описание | Примечание |
---|---|---|---|
fileType | csv или xlsx Например: fileType=xlsx |
Формат выгружаемого файла | Если не указан, то по умолчанию csv |
settings * | Массив значений | Массив со всеми настройками для формирования отчётов | |
settings[filter] * | Массив значений | Массив всех фильтров | Ключ массива является названием фильтра |
settings[filter][date] * | Массив значений | Фильтр «диапазон дат» | |
settings[filter][date][from] * | Дата Например: settings[filter][date][from]=2020-11-30 для одного интервала ИЛИ settings[filter][date][0][from]=2020-11-30&settings[filter][date][1][from]=2020-12-30 для нескольких интервалов |
Начало диапазона | Не может быть меньше 1970-01-01; не может быть больше текущей даты; должна быть не больше, чем settings[filter][date][to] |
settings[filter][date][to] * | Дата Например: settings[filter][date][to]=2020-12-30 для одного интервала ИЛИ settings[filter][date][0][to]=2020-11-30&settings[filter][date][1][to]=2020-12-30 для нескольких интервалов |
Конец диапазона | Не может быть больше текущей даты; должна быть не меньше, чем settings[filter][date][from] |
settings[filter][dimension] | Массив значений | Фильтр по разрезам | Ключ массива является названием фильтра |
settings[filter][dimension][idApp][value] | Массив целых значений Например: settings[filter][dimension][idApp][value][]=1 |
Фильтр по приложениям | |
settings[filter][dimension][idPartner][value] | Массив целых значений Например: settings[filter][dimension][idPartner][value][]=1 |
Фильтр по партнёрам | |
settings[filter][dimension][idCampaign][value] | Массив целых значений Например: settings[filter][dimension][idCampaign][value][]=1 |
Фильтр по кампаниям | |
settings[filter][dimension][idTrafficType][value] | Массив целых значений Например: settings[filter][dimension][idTrafficType][value][]=1 |
Фильтр по типам трафика | |
settings[filter][dimension][idAd][value] | Массив целых значений Например: settings[filter][dimension][idAd][value][]=1 |
Фильтр по трекинг-ссылкам | |
settings[filter][dimension][idAppStoreCleaned][value] | Массив целых значений Например: settings[filter][dimension][idAppStoreCleaned][value][]=1 |
Фильтр по сервисам установок | |
settings[filter][dimension][idAccount][value] | Массив целых значений Например: settings[filter][dimension][idAccount][value][]=1 |
Фильтр по аккаунтам | |
settings[filter][dimension][idProject][value] | Массив целых значений Например: settings[filter][dimension][idProject][value][]=1 |
Фильтр по проектам | |
settings[filter][dimension][idAdMediator][value] | Массив целых значений из словаря
Рекламные медиаторы Например: settings[filter][dimension][idAdMediator][value][]=1 |
Фильтр по рекламным медиаторам | |
settings[filter][dimension][idAdEventType][value] | Массив целых значений из словаря
Тип атрибуции Например: settings[filter][dimension][idAdEventType][value][]=1 |
Фильтр по типу атрибуции | |
settings[filter][dimension][idCountry][value] | Массив целых значений Например: settings[filter][dimension][idCountry][value][]=1 |
Фильтр по странам | |
settings[filter][dimension][idRegion][value] | Массив целых значений Например: settings[filter][dimension][idRegion][value][]=1 |
Фильтр по регионам | |
settings[filter][dimension][idCity][value] | Массив целых значений Например: settings[filter][dimension][idCity][value][]=1 |
Фильтр по городам | |
settings[filter][dimension][idAgeInterval][value] | Массив целых значений Например: settings[filter][dimension][idAgeInterval][value][]=18 |
Фильтр по возрасту | Доступные значения: 17 — 1-17 18 — 18-24 25 — 25-34 35 — 35-44 45 — 45-54 55 — 55-64 65 — 65+ |
settings[filter][dimension][idGender][value] | Массив целых значений Например: settings[filter][dimension][idGender][value][]=1 |
Фильтр по полу | Доступные значения: 1 — мужской 2 — женский |
settings[filter][dimension][idManufacturerCleaned][value] | Массив целых значений Например: settings[filter][dimension][idManufacturerCleaned][value][]=1 |
Фильтр по производителям | |
settings[filter][dimension][idOsFamily][value] | Массив целых значений Например: settings[filter][dimension][idOsFamily][value][]=1 |
Фильтр по ОС | Доступные значения: 1 — другие 2 — Android 3 — iOS 4 — Windows 5 — Linux 6 — MacOS 7 — TV |
settings[filter][dimension][idDeviceModelCleaned][value] | Массив целых значений Например: settings[filter][dimension][idDeviceModelCleaned][value][]=1 |
Фильтр по моделям устройств | |
settings[filter][dimension][idMobileTelecomBrand][value] | Массив целых значений Например: settings[filter][dimension][idMobileTelecomBrand][value][]=1 |
Фильтр по брендам мобильных операторов | |
settings[filter][dimension][attStatus][value] | Массив целых значений Например: settings[filter][dimension][attStatus][value][]=1 |
Фильтр по ATT Статусу Подробнее | Доступные значения: 0 — Неизвестно 1 — Разрешение не запрошено 2 — Разрешение невозможно 3 — Разрешение отклонено 4 — Разрешение получено |
settings[filter][dimension][idBrowser][value] | Массив целых значений Например: settings[filter][dimension][idBrowser][value][]=1 |
Фильтр по браузерам | |
settings[filter][dimension][idConnectionType][value] | Массив целых значений Например: settings[filter][dimension][idConnectionType][value][]=1 |
Фильтр по типам соединения | Доступные значения: 1 — мобильная связь 2 — Wi-Fi |
settings[filter][dimension][bluetoothEnabled][value] | Массив целых значений Например: settings[filter][dimension][bluetoothEnabled][value][]=1 |
Фильтр по активности bluetooth | |
settings[filter][dimension][adTrackingEnabled][value] | Массив целых значений Например: settings[filter][dimension][adTrackingEnabled][value][]=1 |
Фильтр по статусам персонализации рекламы | |
settings[filter][dimension][idOsDeviceType][value] | Массив целых значений Например: settings[filter][dimension][idOsDeviceType][value][]=1 |
Фильтр по типам устройства | Доступные значения: 1 — другие 2 — смартфоны 3 — компьютеры 4 — телевизоры |
settings[filter][dimension][idOsTimezone][value] | Массив целых значений Например: settings[filter][dimension][idOsTimezone][value][]=1 |
Фильтр по часовому поясу ОС | |
settings[filter][dimension][idOsLang][value] | Массив целых значений Например: settings[filter][dimension][idOsLang][value][]=1 |
Фильтр по языку ОС | |
settings[filter][dimension][rooted][value] | Массив целых значений из словаря
Рутованное устройство Например: settings[filter][dimension][rooted][value][]=1 |
Фильтр по статусу root/jailbreak | |
settings[filter][dimension][idProduct][value] | Массив целых значений Например: settings[filter][dimension][idProduct][value][]=1 |
Фильтр по продукту | |
settings[filter][dimension][idCurrency][value] | Массив целых значений Например: settings[filter][dimension][idCurrency][value][]=1 |
Фильтр по валюте | |
settings[filter][dimension][idSubscriptionType][value] | Массив целых значений Например: settings[filter][dimension][idSubscriptionType][value][]=1 |
Фильтр по типу подписки | Доступные значения: 1 — без подписки 2 — триальная 3 — платная |
settings[filter][dimension][idRevenueType][value] | Массив целых значений Например: settings[filter][dimension][idRevenueType][value][]=1 |
Фильтр по типу дохода | Доступные значения: 1 — покупка 2 — подписка 3 — рекламная монетизация 4 — универсальный доход |
settings[filter][dimension][customEventName][value] | Массив строк Например: settings[filter][dimension][customEventName][value][]=Event1 |
Фильтр по названию событий | |
settings[filter][dimension][idPlatform][value] | Массив целых значений Например: settings[filter][dimension][idPlatform][value][]=1 |
Фильтр по платформе приложения | Доступные значения: 1 — Android 2 — iOS 3 — Windows 4 — Web |
settings[filter][dimension][idSegment][value] | Массив целых значений Например: settings[filter][dimension][idSegment][value][]=1 |
Фильтр по сегментам | |
settings[filter][dimension][isVerified][value] | Массив целых значений Например: settings[filter][dimension][isVerified][value][]=1 |
Фильтр по верификации платежа | Доступные значения: 0 — не верифицирована 1 — верифицирована 255 — неизвестно |
settings[filter][dimension][screenWidth][min] | Цифровое значение Например: settings[filter][dimension][screenWidth][min]=500 |
Фильтр по минимальной ширине экрана | |
settings[filter][dimension][screenWidth][max] | Цифровое значение Например: settings[filter][dimension][screenWidth][max]=1024 |
Фильтр по максимальной ширине экрана | |
settings[filter][dimension][screenHeight][min] | Цифровое значение Например: settings[filter][dimension][screenHeight][min]=500 |
Фильтр по минимальной высоте экрана | |
settings[filter][dimension][screenHeight][max] | Цифровое значение Например: settings[filter][dimension][screenHeight][max]=1024 |
Фильтр по максимальной высоте экрана | |
settings[filter][dimension][screenDiagonal][min] | Цифровое значение Например: settings[filter][dimension][screenDiagonal][min]=4 |
Фильтр по минимальной диагонали экрана | |
settings[filter][dimension][screenDiagonal][max] | Цифровое значение Например: settings[filter][dimension][screenDiagonal][max]=10 |
Фильтр по максимальной диагонали экрана | |
settings[filter][dimension][params][value] | Массив строк Например: settings[filter][dimension][params][value][]=value1 |
Фильтр по параметрам событий | При settings[filter][dimension][params][cmp][]=exist должна быть передана пустая строка settings[filter][dimension][params][value][]= |
settings[filter][dimension][params][name] | Массив строк Например: settings[filter][dimension][params][name][]=name1 |
Фильтр по названию параметра | |
settings[filter][dimension][params][cmp] | Массив строк Например: settings[filter][dimension][params][cmp][]=< |
Оператор сравнения параметров кастомных событий и их значений | Доступные значения: equals — совпадает startsWith — начинается на endsWith — кончается на contains — содержит exist — присутствует !equals — не совпадает !startsWith — не начинается на !endsWith — не кончается на !contains — не содержит = != > < >= <= |
settings[filter][dimension][params][join] | Одно из значений: and, or Например: settings[filter][dimension][params][join]=and |
Правило сочетания нескольких фильтров по параметрам Подробнее | Имеет смысл только при 2 и более фильтрах по параметрам |
settings[filter][dimension][params][target] | Одно из значений: events, params Например: settings[filter][dimension][params][target]=events |
Выбор цели фильтрации Подробнее | |
settings[filter][dimension][appVersion] | Массив значений | Фильтр по версии приложения | |
settings[filter][dimension][appVersion][operator][] | Массив значений из словаря
Операторы сравнения Например: settings[filter][dimension][appVersion][operator][]=> |
Оператор сравнения для фильтра по версии | |
settings[filter][dimension][appVersion][major][] | Массив чисел Например: settings[filter][dimension][appVersion][major][]=1 |
Фильтр по мажорной версии приложения | |
settings[filter][dimension][appVersion][minor][] | Массив чисел Например: settings[filter][dimension][appVersion][minor][]=1 |
Фильтр по минорной версии приложения |
Действует только при заданном settings[filter][dimension][appVersion][major] Если фильтр по минорной версии не нужен, то должно быть передано пустое значение settings[filter][dimension][appVersion][minor][]= |
settings[filter][dimension][appVersion][patch][] | Массив чисел Например: settings[filter][dimension][appVersion][patch][]=1 |
Фильтр по патч-версии приложения | Действует только при заданных settings[filter][dimension][appVersion][major] и
settings[filter][dimension][appVersion][minor] Если фильтр по патч-версии не нужен, то должно быть передано пустое значение settings[filter][dimension][appVersion][patch][]= |
settings[filter][dimension][trackerSdkVersion] | Массив значений | Фильтр по версии SDK | |
settings[filter][dimension][trackerSdkVersion][operator][] | Массив значений из словаря
Операторы сравнения Например: settings[filter][dimension][trackerSdkVersion][operator][]=> |
Оператор сравнения для фильтра по версии | |
settings[filter][dimension][trackerSdkVersion][major][] | Массив чисел Например: settings[filter][dimension][trackerSdkVersion][major][]=1 |
Фильтр по мажорной версии SDK | |
settings[filter][dimension][trackerSdkVersion][minor][] | Массив чисел Например: settings[filter][dimension][trackerSdkVersion][minor][]=1 |
Фильтр по минорной версии SDK | Действует только при заданном settings[filter][dimension][trackerSdkVersion][major] Если фильтр по минорной версии не нужен, то должно быть передано пустое значение settings[filter][dimension][trackerSdkVersion][minor][]= |
settings[filter][dimension][trackerSdkVersion][patch][] | Массив чисел Например: settings[filter][dimension][trackerSdkVersion][patch][]=1 |
Фильтр по патч-версии SDK | Действует только при заданных settings[filter][dimension][trackerSdkVersion][major] и
settings[filter][dimension][trackerSdkVersion][minor] Если фильтр по патч-версии не нужен, то должно быть передано пустое значение settings[filter][dimension][trackerSdkVersion][patch][]= |
settings[filter][dimension][osVersion] | Массив значений | Фильтр по версии операционной системы | |
settings[filter][dimension][osVersion][operator][] | Массив значений из словаря
Операторы сравнения Например: settings[filter][dimension][osVersion][operator][]=> |
Оператор сравнения для фильтра по версии | |
settings[filter][dimension][osVersion][major][] | Массив чисел Например: settings[filter][dimension][osVersion][major][]=1 |
Фильтр по мажорной версии ОС | |
settings[filter][dimension][osVersion][minor][] | Массив чисел Например: settings[filter][dimension][osVersion][minor][]=1 |
Фильтр по минорной версии ОС | Действует только при заданном settings[filter][dimension][osVersion][major] Если фильтр по минорной версии не нужен, то должно быть передано пустое значение settings[filter][dimension][osVersion][minor][]= |
settings[filter][dimension][osVersion][patch][] | Массив чисел Например: settings[filter][dimension][osVersion][patch][]=1 |
Фильтр по патч-версии ОС | Действует только при заданных settings[filter][dimension][osVersion][major] и
settings[filter][dimension][osVersion][minor] Если фильтр по патч-версии не нужен, то должно быть передано пустое значение settings[filter][dimension][osVersion][patch][]= |
settings[filter][dimension][%filterName%][invert] | Одно из значений: 0 — выкл (по умолчанию) 1 — вкл Например: settings[filter][dimension][idApp][invert]=1 |
Исключение выбранного в фильтре %filterName% При 0 отчёт будет построен по settings[filter][dimension][%filterName%][value], при 1 из отчёта будут исключены settings[filter][dimension][%filterName%][value] |
Исключить выбранное можно в любом фильтре по разрезам [dimension], кроме [isVerified], [screenWidth], [screenHeight], [screenDiagonal], [appVersion], [rooted], [trackerSdkVersion], [osVersion] |
settings[filter][value] | Массив значений | Фильтр по значению выбранного селектора | |
settings[filter][value][column] | Одно из значений селектора отчётов Например: settings[filter][value][column]=countInstall |
Название селектора, по значению которого будет выполнена фильтрация | Название селектора должно быть среди settings[selectors] Допустимы только метрики (не разрезы) |
settings[filter][value][operator] | Одно из значений оператора сравнения Например: settings[filter][value][operator]=< |
Оператор сравнения для условия фильтрации | |
settings[filter][value][value] | Произвольная строка Например: settings[filter][value][value]=3442 |
Значение, с которым выполняется сравнение | |
settings[filter][topN] | Массив значений | Top-N фильтр для ограничения количества строк результата выборки | |
settings[filter][topN][column] | Одно из значений селектора отчётов Например: settings[filter][topN][column]=idApp |
Название селектора, по значениям которого выполняется фильтрация Top-N | Название селектора должно быть среди settings[selectors] |
settings[filter][topN][count] | Целое положительное число Например: settings[filter][topN][count]=10 |
Количество строк результата выборки после фильтрации Top-N | Действует только при указанном значении settings[filter][topN][column] |
settings[groupBy] | Одно из значений селектора группировки Например: settings[groupBy]=idApp |
Параметр, по которому будет произведена группировка данных | Название селектора должно быть среди settings[selectors] При этом в settings[selectors] должно быть не менее 2 селекторов доступных для группировки |
settings[transposition] | 0, 1, 2 Например: settings[transposition]=0 |
Транспонирование результата выборки | Доступные значения: 0 — выключено 1 — сначала группирующая колонка 2 — сначала метрики |
settings[idCurrency] | Одно из значений валюты Например: settings[idCurrency]=643 |
Валюта, в которой будут выводиться денежные показатели | По умолчанию 643 (российский рубль) |
settings[tz] | Одно значение из словаря Часовые пояса
Например: settings[tz]=Asia%2FYekaterinburg |
||
settings[precision] | Не отрицательное целое число Например: settings[precision]=2 |
Количество выводимых знаков после запятой | |
settings[retIndent] | Положительное целое число Например: settings[retIndent]=3600 |
Отступ в секундах для селекторов Retention | Задаёт количество секунд, которые не учитываются в показателях Retention. Подробнее. |
settings[rrLimit] | Положительное целое число Например: settings[rrLimit]=2592000 |
Ограничение в секундах для селекторов Rolling Retention | Задаёт количество секунд, которым будет ограничен период для расчёта Rolling Retention. Подробнее. |
settings[comparison] | Массив значений | Вывод сравнительной характеристики такого же отчёта с другим диапазоном дат | |
settings[comparison][type] | Одно значение из словаря
Тип сравнения отчётов Например: settings[comparison][type]=1 |
Тип сравнения | |
settings[comparison][interval] | Положительное целое число Например: settings[comparison][interval]=10 |
Интервал, с которым будет производиться сравнение |
Если указать значение 100001 — Предыдущий период,
то сравнение settings[filter][date]
будет выполнено с предшествующим аналогичным периодом
Действует только если settings[comparison][type] != 0 |
settings[selectors] * | Несколько значений из словаря
Селекторов отчётов,
через запятую Например: settings[selectors]=idApp,age,idGender |
Список полей, которые должны присутствовать в выгрузке | |
settings[title] | Строка Например: settings[title]=TestReport |
Название отчёта |
* — обязательные параметры
Для предотвращения ошибок в отчёте, рекомендуем завершать каждый запрос следующим набором селекторов (значения приведены для примера):
&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. Например:
{
"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"
}
}
}
{
"code": 403,
"message": "Access denied",
"data": null
}
{
"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"
}
]
}
}
}
}