API глобальной статистики
Этот раздел описывает параметры запроса и данные результата API глобальной статистики.
Маршруты API статистики были переименованы:
/statistics/advertiser/...->/statistics/a/.../statistics/publisher/...->/statistics/p/...
API глобальной статистики показывает пропущенные RTB-запросы только для Date, Sites, Zones, Countries, Regions и Sub IDs.
количество
Возвращать только общее количество результатов.
целое число
необязательный
подробный
Получить больше подробностей, если возможно.
целое число
необязательный
часовой пояс
Настройка часового пояса для фильтра 'hour' и 'group_by'
строка
необязательный
итоги
Указывает, добавлять ли итоги в ответ или нет.
целое число
необязательный
фильтр
Фильтры для ограничения возвращаемых значений запроса статистики
объект
необязательный
group_by
Список значений group_by, применяемых к данным. Допускается максимум четыре.
массив
обязательный
order_by
Сортировка результатов по определённым полям. Допускается максимум два.
массив
необязательный
projection
Отдельные подструктуры, которые пользователь хочет получить в ответе.
массив
необязательный
limit
Количество записей, которые нужно вернуть в этом ответе.
целое число
необязательный
offset
Позиция, с которой нужно получить записи.
целое число
необязательный
Параметр count
Свойство
количество
Тип
необязательный
Тип переменной
целое число
Значение по умолчанию
0
Доступные значения
[0, 1]
Описание
Возвращать только общее количество результатов.
Пример:
Параметр detailed
Свойство
подробный
Тип
необязательный
Тип переменной
целое число
Значение по умолчанию
0
Доступные значения
[0, 1]
Описание
Возвращать подробную информацию или нет.
Пример:
Параметр timezone
Настройка часового пояса для hour фильтра и group_by.
Свойство
часовой пояс
Тип
необязательный
Тип переменной
строка
Значение по умолчанию
America/New_york
Доступные значения
Установить поле часового пояса из /collections/timezones
Описание
ПРИМЕЧАНИЕ: часовые пояса актуальны только при запросах на основе почасовых данных; для данных не по часам это не влияет.
Пример:
Параметр totals
Свойство
итоги
Тип
необязательный
Тип переменной
целое число
Значение по умолчанию
0
Доступные значения
[0,1]
Описание
Указывает, добавлять ли итоги в ответ или нет.
Пример:
Параметр filter
Свойство
фильтр
Тип
необязательный
Тип переменной
объект
Доступный вариант для рекламодателей
[”adblock”, ”advertiser_ad_type_id”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date_from”, “date_to”, “device_id”, “device_type_id”, hour”, “language_id”, “operating_system_id”, “region_id”, “site_hostname”, “site_id”, “size”, “sub”, “zone_id”, “campaign_group_id”, “campaign_id”, “exclude_deleted”, “offer_id”, “offer_landing_page_id”, “variation_id”]
Доступный вариант для издателей
[”adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date_from”, “date_to”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “region_id”, “site_hostname”, “site_id”, “zone_id”, “publisher_ad_type_id”, “size”, “sub”]
Описание
Фильтровать по определённым параметрам.
Фильтр: country_iso
country_isoСвойство
country_iso
Тип
необязательный
Тип переменной
строка
Значение по умолчанию
-
Доступные значения
См. свойство iso3 в эндпоинте /collections/countries
Описание
Список кодов ISO 3
Пример:
Фильтр date_from, date_to
date_from, date_toЭтот date_from и date_to параметры управляют окном, за которое вы хотите получить информацию о статистике.
date_from: дата начала диапазона для статистики (по умолчанию — начало месяца),
date_to: дата окончания диапазона для статистики (по умолчанию — сегодня)
Свойство
date_from, date_to
Тип
необязательный
Тип переменной
строка
Значение по умолчанию
По умолчанию даты относятся к текущему месяцу.
Доступные значения
YYYY-mm-dd
Описание
Диапазон дат от/до для статистики. Формат YYYY-mm-dd
Пример:
Часовые пояса актуальны только при запросах на основе почасовых данных; для данных не по часам это не влияет.
Фильтр: advertiser_ad_type_id, campaign_group_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, publisher_ad_type_id
Свойство
advertiser_ad_type_id, campaign_group_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, advertiser_ad_type_id, publisher_ad_type_id
Тип
необязательный
Тип переменной
массив
Тип элементов
целое число
Значение по умолчанию
-
Доступные значения
Относительные свойства ИЛИ коллекции
Описание
Список ID сущностей
Пример:
Фильтр: exclude_deleted
exclude_deletedСвойство
exclude_deleted
Тип
необязательный
Тип переменной
целое число
Значение по умолчанию
0
Доступные значения
[0, 1]
Описание
Исключать удалённые кампании или нет.
Пример:
Фильтр: adblock
adblockСвойство
adblock
Тип
необязательный
Тип переменной
строка
Значение по умолчанию
"all"
Доступные значения
"adblock", "all", "standard"
Описание
Включать зоны adblock или нет.
Пример:
Фильтр: site_hostname
site_hostnameСвойство
site_hostname
Тип
необязательный
Тип переменной
строка
Значение по умолчанию
-
Доступные значения
Допустимые символы для имён хостов: буквы от a до z, цифры от 0 до 9, дефис и точка.
Описание
Фильтр по имени хоста сайта.
Пример:
Фильтр: size
sizeСвойство
size
Тип
необязательный
Тип переменной
строка
Значение по умолчанию
-
Доступные значения
Допустимые символы для size — цифры от 0 до 9 и символ x. Пример 300x100
Описание
Фильтр по размеру
Пример:
Параметр group_by
Свойство
group_by
Тип
обязательный
Тип переменной
массив
Тип элементов
строка
Значение по умолчанию
-
Доступные значения для рекламодателей
[”adblock”, “advertiser_ad_type_id”, browser_id”, “idcampaign_group“, “campaign_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “hour”, “device_id”, “device_type_id”, “language_id”, “operating_system_id”, “region_id”, “site_id”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”, “offer_id”, “offer_landing_page_id”, “site_hostname”, “size”, “variation_id”]
Доступные значения для издателей
[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “publisher_ad_type_id” “region_id”, “site_id”, “size”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”]
Описание
Список подзапросов для включения дополнительных данных в ответ.
Пример:
Параметр order_by
Тип
необязательный
Тип переменной
массив
Тип элементов
строка
Значение по умолчанию
-
Доступные значения полей метрик
[“cpc”, “cpc”, “cpm”, “cpv”, “ctr”, “clicks”, “impressions”, “video_impressions”, “video_views”, “vtr”, “rtb_win_ratio”, “rtb_avg_total_time”, “rtb_skipped”, “rtb_bid_response_ratio”, “rtb_avg_cpm”, “rtb_timeouts_ratio”, “rt_errors_ratio”, “rtb_no_bid_ratio”, “rtb_skipped_ratio”]
Доступные значения полей, зависящие от `group_by`, для рекламодателей
[”adblock”, “browser_id”, “campaign_id”, “carrier_id”, “category_id”, “country_iso”, “device_id”, “date”, “device_type_id”, “hour”, “ecpa1”, “g1”,“language_id”, “month”, “offer_id”, “offer_landing_page_id”, “operating_system_id”, “quarter”, “region_id”, “site_hostname”, “site_id”, “sub”, “variation_id”, “week”, “year” ,“zone_id”]
Доступные значения полей, зависящие от `group_by`, для издателей
[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “device_id”, “date”, “device_type_id” , “hour”, “language_id”, “month”, “operating_system_id”, “quarter”, “region_id”, “site_id”, “sub”, “week”, “year”, “zone_id”]
Доступные значения сортировки
[“asc”, “desc”]
Описание
Список доступных вариантов сортировки
Подсказки:
Поля метрик всегда доступны для использования в качестве поля сортировки.
Чтобы сортировать по конкретному значению (например, по “browser_id”), его нужно включить в параметр “group_by”.
Значения “g1”, “ecpa1” доступны только при наличии у пользователя отслеживания конверсий (Goals). Все цели связаны с серийным номером (g1, g2, …gx). Значения eCPA соответственно ecpa1, ecpa2, …ecpax.
Пример:
Чтобы упорядочить результаты кампании хронологически, “date” нужно включить и в “group_by”, и в “order_by”:
Параметр projection
Параметр projection определяет, что будет возвращено в результирующем payload. Если не указано, будут возвращены все подструктуры.
Тип
необязательный
Тип переменной
объект
Тип элементов
массив
Значение по умолчанию
все варианты, см. ниже
Доступные значения полей для рекламодателей
[“base”, “rtb”, “video”, “goals*”]
Доступные значения полей для издателей
[“base”, “rtb”, “video”, “wpn”]
*Некоторые поля "goal", такие как "profit" и "roi", рассчитываются на основе стоимости кампании, поэтому вам также нужно использовать поле "base", если вы хотите получать корректные метрики "goals".
Примеры:
Чтобы получить все возможные метрики как рекламодатель, используйте:
Чтобы получить все возможные метрики как издатель, используйте:
Вы также можете указать метрики внутри каждого поля projection:
Единственное поле, которое не позволяет указывать конкретные метрики projection, — это "goals"
Параметр limit
Количество записей, которые нужно вернуть в этом ответе.
Свойство
limit
Тип
необязательный
Тип переменной
целое число
Значение по умолчанию
50
Пример:
Параметр offset
Позиция, с которой нужно получить записи.
Свойство
offset
Тип
необязательный
Тип переменной
целое число
Значение по умолчанию
0
Пример
Пример 1
Статистика кампании рекламодателя с фильтрацией.
Запрос:
Ответ:
Пример 2
Статистика рекламодателя по датам за текущий месяц, отсортированная по числу показов.
Запрос:
Ответ:
Пример 3
Статистика издателя по date и region_id, отсортированная по impressions.
Запрос:
Ответ:
Пример 4
Статистика издателя по site_id с проекцией.
Запрос:
Ответ
Последнее обновление
Это было полезно?

