Описание методов API
Содержание
Методы API, возвращающие данные о статистике по различным срезам. Поддерживается режим отложенной загрузки, который используется при запуске длительных отчетов. В этом случае метод возвращает статус 204 и идентификатор в поле request_id. Полученный request_id необходимо подставить в запрос как GET-параметр. В таблице в колонке "Описание" представлены названия отчётов из интерфейса вебмастера по группам.
statistics-offers
Формат:
GET /api/rest/webmaster/xml/statistics-offers/{group_field}/{date_from}/{date_to}?sub_group=<enum>&date_type=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&request_id=<int>
Описание:
Возвращает данные о статистике по офферам. Данный метод возвращает список офферов с информацией и показателями эффективности по каждому из них. В список офферов попадают те офферы, по которым за выбранный период (с date_from по date_to) были конверсии.
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, channel_id, points_types, points_landings, target_pages, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_offersResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера (параметр группировки при group_field=action_id)--></actionID>
- <actionName>string <!--название оффера (параметр группировки при group_field=action_id)--></actionName>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <area>string <!--регион пользователя--></area>
- <eventTime>string</eventTime>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <browser>string <!--броузер пользователя--></browser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <categoryId>string <!--id категори--></categoryId>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <city>string <!--город пользователя--></city>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <channelId>int <!--id канала--></channelId>
- <newUser>string <!--тип посетителя--></newUser>
- <deviceName>string <!--устройство--></deviceName>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
- <feedName>string <!--название инструмента--></feedName>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <language>string <!--язык пользователя--></language>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <linkName>string <!--название ссылки--></linkName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <os>string <!--операционная система пользователя--></os>
- <osType>string <!--osType-comment-ru--></osType>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <productId>string <!--id товара--></productId>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoName>string <!--название баннера--></promoName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <keyword>string <!--ключевое слово--></keyword>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <typeOffers>string <!--тип оффера--></typeOffers>
</item>
</items> - <request_status_in_queue>string</request_status_in_queue>
</data>
</ca.api.webmaster.statistics_offersResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-offers/action_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-segments
Формат:
GET /api/rest/webmaster/xml/statistics-segments/{group_field}/{date_from}/{date_to}?sub_group=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&date_type=<enum>&request_id=<int>
Описание:
Возвращает данные о статистике по типам и бизнес-категориям офферов. Данный метод возвращает список типов офферов, вертикалей, категорий либо подкатегорий (в зависимости от параметра group_field):
- Типы офферов (показатели эффективности для различных типов офферов)
- Вертикали (данные по всем типам офферов, сгруппированные бизнес-категориям 1го уровня)
- Категории (данные по всем типам офферов, сгруппированные по бизнес-категориям 2го уровня)
- Подкатегории (данные по всем типам офферов, сгруппированные по бизнес-категориям 3го уровня)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Типы офферов |
type_offers |
Вертикали |
category_lvl_1 |
Категории |
category_lvl_2 |
Подкатегории |
category_lvl_3 |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, channel_id, points_types, points_landings, target_pages, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_segmentsResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера (параметр группировки при group_field=type_offers)--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня (параметр группировки при group_field=category_lvl_1)--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня (параметр группировки при group_field=category_lvl_2)--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня (параметр группировки при group_field=category_lvl_3)--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <channelId>int <!--id канала--></channelId>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_segmentsResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-segments/type_offers/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-actions
Формат:
GET /api/rest/webmaster/xml/statistics-actions/{group_field}/{date_from}/{date_to}?sub_group=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&date_type=<enum>&request_id=<int>
Описание:
Возвращает данные о статистике по типам конверсий (лиды и продажи) либо по методам оплаты (в зависимости от параметра group_field):
- Типы конверсий (показатели эффективности по каждому из типов конверсий - по лидам и по продажам)
- Методы оплаты (показатели эффективности для различных методов оплаты)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Типы конверсий |
type_actions |
Методы оплаты |
payment_method_id |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, seasons, daytime, weekends, weekdays, channel_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_actionsResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа) (параметр группировки при group_field=type_actions)--></isSale>
- <paymentMethod>string <!--способ оплаты (параметр группировки при group_field=payment_method_id)--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <channelId>int <!--id канала--></channelId>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_actionsResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-actions/type_actions/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-rate
Формат:
GET /api/rest/webmaster/xml/statistics-rate/{group_field}/{date_from}/{date_to}?sub_group=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&date_type=<enum>&request_id=<int>
Описание:
Возвращает данные об интенсивности конверсий по различным временным периодам, сезонам, времени суток, дням недели либо выходным и будним дням (в зависимости от параметра group_field):
- Часы (показатели эффективности по каждому из часов в выбранном временном периоде)
- Дни (показатели эффективности по каждому из дней в выбранном временном периоде)
- Недели (показатели эффективности по каждой из недель в выбранном временном периоде)
- Месяцы (показатели эффективности по каждому из месяцев в выбранном временном периоде)
- Кварталы (показатели эффективности по каждому из кварталов в выбранном временном периоде)
- Годы (показатели эффективности по каждому из годов в выбранном временном периоде)
- Сезоны (показатели эффективности по каждому из сезонов в выбранном временном периоде)
- Время суток (показатели эффективности в зависимости от времени суток: ночь - с 0 до 6, утро - с 6 до 12, день - с 12 до 18, вечер - с 18 до 24; показатели считаются по всем дням выбранного временного периода)
- Выходные и будни (показатели эффективности в зависимости от дней недели: выходные - суббота и воскресение, будни - с понедельника по пятницу; показатели считаются по всем дням выбранного временного периода)
- Дни недели (показатели эффективности в зависимости от дней недели: отчет содержит информацию по каждому из дней недели с понедельника по воскресение; показатели считаются по всем дням выбранного временного периода)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Часы |
event_time_hour |
Дни |
event_time_day |
Недели |
event_time_week |
Месяцы |
event_time_month |
Кварталы |
event_time_quarter |
Годы |
event_time_year |
Сезоны |
seasons |
Время суток |
daytime |
Выходные и будни |
weekends |
Дни недели |
weekdays |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, channel_id, points_types, points_landings, target_pages, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_rateResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <channelId>int <!--id канала--></channelId>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <eventTime>string <!--дата (параметр группировки для соответствующего временного периода)--></eventTime>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <daytime>string</daytime>
- <weekends>string</weekends>
- <weekdays>string</weekdays>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_rateResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-rate/event_time_day/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-entrypoints
Формат:
GET /api/rest/webmaster/xml/statistics-entrypoints/{group_field}/{date_from}/{date_to}?sub_group=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&date_type=<enum>&request_id=<int>
Описание:
Возвращает данные о статистике по точкам входа - по их типам, а также детализации по каждому из типов (в зависимости от параметра group_field):
- Типы (показатели эффективности по каждому из типов точек входа)
- Лэндинги, Целевые страницы, Товары и т.д. (показатели эффективности по каждому из типов точек входа)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Типы |
points_types |
Лэндинги |
points_landings |
Целевые страницы |
target_pages |
Промо акции |
points_promo_events |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, channel_id, points_types, points_landings, target_pages, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_entrypointsResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru (параметр группировки при group_field=points_types)--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <channelId>int <!--id канала--></channelId>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_entrypointsResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-entrypoints/points_types/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-sources
Формат:
GET /api/rest/webmaster/xml/statistics-sources/{group_field}/{date_from}/{date_to}?sub_group=<enum>&date_type=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&request_id=<int>
Описание:
Возвращает данные о статистике по источникам трафика - по типам трафика, по реферрерам, субаккаунтам либо ключевым словам (в зависимости от параметра group_field):
- Типы (показатели эффективности по каждому из типов трафика, напр. трафику из социальных сетей)
- Реферреры (показатели эффективности по каждому из реферреров - сайтов, с которых пользователи переходили на сайт вебмастера)
- Субаккаунты (показатели эффективности по субаккаунтам - пользовательским меткам, используемым для категоризации трафика)
- Ключевые слова (показатели эффективности по ключевым словам)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Типы |
typesources |
Реферреры |
referrers |
Субаккаунты |
subaccount, subaccount2, subaccount3, subaccount4, subaccount5 |
Ключевые слова |
keyword_se |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, channel_id, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_sourcesResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово (параметр группировки при group_field=keyword_se)--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru (параметр группировки при group_field=typesources)--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru (параметр группировки при group_field=subaccount)--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр (параметр группировки при group_field=referrers)--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <channelId>int <!--id канала--></channelId>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_sourcesResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-sources/typesources/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-geo
Формат:
GET /api/rest/webmaster/xml/statistics-geo/{group_field}/{date_from}/{date_to}?sub_group=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&date_type=<enum>&request_id=<int>
Описание:
Возвращает данные о статистике по географическим срезам - по языку, странам, регионам, городам либо часовым поясам (в зависимости от параметра group_field):
- Язык (показатели эффективности по языкам пользователей)
- Содружества (показатели эффективности по содружествам стран, из которых были совершены конверсии)
- Страны (показатели эффективности по странам, из которых были совершены конверсии)
- Регионы (показатели эффективности по регионам, из которых были совершены конверсии)
- Города (показатели эффективности по городам, из которых были совершены конверсии)
- Часовые пояса (показатели эффективности по часовым поясам, из которых были совершены конверсии)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Язык |
language |
Страны |
country |
Регионы |
area |
Города |
city |
Часовые пояса |
timezones |
Содружества стран |
commonwealth |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, channel_id, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_geoResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя (параметр группировки при group_field=type_actions)--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя (параметр группировки при group_field=commonwealth)--></commonwealth>
- <country>string <!--страна пользователя (параметр группировки при group_field=country)--></country>
- <area>string <!--регион пользователя (параметр группировки при group_field=area)--></area>
- <city>string <!--город пользователя (параметр группировки при group_field=city)--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <channelId>int <!--id канала--></channelId>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_geoResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-geo/language/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-behaviour
Формат:
GET /api/rest/webmaster/xml/statistics-behaviour/{group_field}/{date_from}/{date_to}?sub_group=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&date_type=<enum>&request_id=<int>
Описание:
Возвращает данные о статистике по поведению пользователей - новым и вернувшимся пользователям:
- Новые и вернувшиеся (показатели эффективности по новым и по вернувшимся пользователям)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Новые и вернувшиеся |
new_user |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, seasons, daytime, weekends, weekdays, channel_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_behaviourResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя (параметр группировки при group_field=new_user)--></newUser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <channelId>int <!--id канала--></channelId>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_behaviourResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-behaviour/new_user/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-technologies
Формат:
GET /api/rest/webmaster/xml/statistics-technologies/{group_field}/{date_from}/{date_to}?sub_group=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&date_type=<enum>&request_id=<int>
Описание:
Возвращает данные о статистике по технологиям - по браузерам, версиям браузера, операционным системам, версиям операционной системы, разрешениям используемых экранов либо их цветности (в зависимости от параметра group_field):
- Браузер (показатели эффективности по браузерам пользователей))
- Версия браузера (показатели эффективности по версиям браузеров пользователей)
- Операционная система (показатели эффективности по операционным системам пользователей)
- Версия операционной системы (показатели эффективности версиям операционных систем пользователей)
- Разрешение экрана (показатели эффективности по разрешениям экранов пользователей)
- Цвета экрана (показатели эффективности по цветам экранов пользователей)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Браузер |
browser_type |
Версия браузера |
browser_version |
Операционная система |
os_type |
Версия операционнай системы |
os_version |
Разрешение экрана |
resolution |
Цвета экрана |
color |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_promo_events, channel_id, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_technologiesResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <browserType>string <!--browserType-comment-ru (параметр группировки при group_field=browser_type)--></browserType>
- <browser>string <!--броузер пользователя (параметр группировки при group_field=browser_version)--></browser>
- <osType>string <!--osType-comment-ru (параметр группировки при group_field=os_type)--></osType>
- <os>string <!--операционная система пользователя (параметр группировки при group_field=os_version)--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru (параметр группировки при group_field=resolution)--></resolution>
- <channelId>int <!--id канала--></channelId>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_technologiesResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-technologies/os_type/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-channels
Формат:
GET /api/rest/webmaster/xml/statistics-channels/{group_field}/{date_from}/{date_to}?sub_group=<enum>&date_type=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&request_id=<int>
Описание:
Возвращает данные о статистике по каналам. Данный метод возвращает список каналов с информацией и показателями эффективности по каждому из них. В список каналов попадают те каналы, по которым за выбранный период (с date_from по date_to) были конверсии.
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_channelsResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера (параметр группировки при group_field=action_id)--></actionID>
- <actionName>string <!--название оффера (параметр группировки при group_field=action_id)--></actionName>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <area>string <!--регион пользователя--></area>
- <eventTime>string</eventTime>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <browser>string <!--броузер пользователя--></browser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <categoryId>string <!--id категори--></categoryId>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <city>string <!--город пользователя--></city>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <channelId>int <!--id канала--></channelId>
- <newUser>string <!--тип посетителя--></newUser>
- <deviceName>string <!--устройство--></deviceName>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
- <feedName>string <!--название инструмента--></feedName>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <language>string <!--язык пользователя--></language>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <linkName>string <!--название ссылки--></linkName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <os>string <!--операционная система пользователя--></os>
- <osType>string <!--osType-comment-ru--></osType>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <productId>string <!--id товара--></productId>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoName>string <!--название баннера--></promoName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <keyword>string <!--ключевое слово--></keyword>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <typeOffers>string <!--тип оффера--></typeOffers>
</item>
</items> - <request_status_in_queue>string</request_status_in_queue>
</data>
</ca.api.webmaster.statistics_channelsResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-channels/channel_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-devices
Формат:
GET /api/rest/webmaster/xml/statistics-devices/{group_field}/{date_from}/{date_to}?sub_group=<enum>&date_type=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&request_id=<int>
Описание:
Возвращает данные о статистике по устройствам пользователей - по типам устройств либо по моделям устройств (в зависимости от параметра group_field):
- Типы устройств (показатели эффективности по типам устройств пользователей)
- Модели устройств (показатели эффективности по моделям устройств пользователей)
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
enum | group_field |
Типы устройств |
device_type_id |
Модели мобильных устройств |
mobile_device |
| |
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, channel_id, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, new_user, browser_type, browser_version, os_type, os_version, resolution, device_type_id, device_id | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | start | номер первого элемента. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
int | request_id | номер запроса | | |
Ответ:
- <ca.api.webmaster.statistics_devicesResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <items>
- <item>
- <actionID>string <!--id оффера--></actionID>
- <actionName>string <!--название оффера--></actionName>
- <typeOffers>string <!--тип оффера--></typeOffers>
- <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
- <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
- <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
- <categoryId>string <!--id категори--></categoryId>
- <isSale>string <!--тип действия (действие или продажа)--></isSale>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <language>string <!--язык пользователя--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--содружество пользователя--></commonwealth>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства (параметр группировки при group_field=device_type_id)--></deviceTypeName>
- <deviceName>string <!--устройство (параметр группировки при group_field=device_id)--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <feedName>string <!--название инструмента--></feedName>
- <promoName>string <!--название баннера--></promoName>
- <linkName>string <!--название ссылки--></linkName>
- <promoTypeId>string <!--промо категория--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-ru--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-ru--></linkTypeName>
- <promoSize>string <!--promoSize-comment-ru--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-ru--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-ru--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-ru--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <productId>string <!--id товара--></productId>
- <resolution>string <!--resolution-comment-ru--></resolution>
- <channelId>int <!--id канала--></channelId>
- <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
- <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
- <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
- <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--количество открытых действий--></leadsOpen>
- <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
- <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
- <saleOpen>int <!--количество открытых продаж--></saleOpen>
- <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
- <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
- <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
- <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
- <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
- <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
- <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
- <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
- <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
- <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
- <ecpc>string <!--средняя стоимость клика--></ecpc>
- <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_devicesResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/statistics-devices/device_type_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9orderstatistics
Формат:
GET /api/rest/webmaster/xml/orderstatistics/{date_from}/{date_to}?sub_group=<enum>&date_type=<enum>&start=<int>&limit=<int>&action_id=<string>&channel_id=<int>&q=<string>&xid=<string>&request_id=<int>&show_detailed_basket=<boolean>¤cy_code=<string>
Описание:
Возвращает данные о статистике по заказам за выбранный период
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
date | date_from | дата начала периода просмотра отчета | | |
date | date_to | дата окончания периода просмотра отчета | | |
enum | sub_group | дополнительный параметр, по которому необходимо сделать группировку | action_id, referrers, language, country, area, city, new_user, channel_id, browser_type, browser_version, os_type, os_version, keyword_se, device_type_id, device_id, tools2 | |
enum | date_type |
Дата совершения конверсии |
conversion |
Дата прогрузки данных |
order_upload |
| conversion, order_upload | |
int | start | номер текущей страницы. По умолчанию 0 | | |
int | limit | количество элементов на странице. По умолчанию 50, но не более 1000 | | |
string | action_id | идентификационный номер оффера | | |
int | channel_id | id канала | | |
string | q | строка поиска по ключевому слову в основном параметре | | |
string | xid | строка поиска по значению xid | | |
int | request_id | номер запроса | | |
boolean | show_detailed_basket | детализация корзины по заказу | | |
string | currency_code | валюта для конвертации, по умолчанию валюта вебмастера | | |
Ответ:
- <ca.api.webmaster.statistics_orderResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <time_zone_api_stat>string</time_zone_api_stat>
- <request_status_in_queue>string</request_status_in_queue>
- <items>
- <item>
- <conversion> <!--тип действия-->
sale|lead|Sale|Lead|Продажа|Лид|Venda|Venta|Petunjuk|Jualan|Lead|Transakcja|促销|
</conversion> - <orderID>string <!--ID заказа в магазине--></orderID>
- <submissionID>string <!--уникальный идентификатор первичного действия в системе--></submissionID>
- <xid>string <!--кастомное поле, которое возвращает набор символов переданный в параметре пользовательской ссылки (?xid=url_data)--></xid>
- <subaccount>string <!--Субаккаунт--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <clickTime>string <!--дата и время перехода по рекламной ссылке--></clickTime>
- <leadTime>string <!--дата и время конверсии--></leadTime>
- <saleTime>string <!--дата и время достижения цели--></saleTime>
- <leadDelta>string <!--время разницы между датой перехода по рекламной ссылке и конверсии--></leadDelta>
- <saleDelta>string <!--время разницы конверсии и достижения цели--></saleDelta>
- <totalDelta>string <!--время разницы между датой перехода по рекламной ссылке и достижения цели--></totalDelta>
- <offerID>string <!--ID офффера--></offerID>
- <offerName>string <!--наименование оффера--></offerName>
- <campaignTargetName>string <!--название цели--></campaignTargetName>
- <country>string <!--страна пользователя--></country>
- <area>string <!--регион пользователя--></area>
- <city>string <!--город пользователя--></city>
- <newUser>string <!--тип посетителя--></newUser>
- <browserType>string <!--browserType-comment-ru--></browserType>
- <browser>string <!--броузер пользователя--></browser>
- <osType>string <!--osType-comment-ru--></osType>
- <os>string <!--операционная система пользователя--></os>
- <keyword>string <!--ключевое слово--></keyword>
- <deviceTypeName>string <!--тип устройства--></deviceTypeName>
- <deviceName>string <!--устройство--></deviceName>
- <promoEngineName>string <!--название инструмента--></promoEngineName>
- <promoEngineId>int <!--id инструмента--></promoEngineId>
- <channelId>int <!--id канала--></channelId>
- <language>string <!--язык пользователя--></language>
- <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
- <status>string</status>
- <customerType>string <!--тип клиента--></customerType>
- <paymentMethod>string <!--способ оплаты--></paymentMethod>
- <basketQTY>string <!--количество товаров в корзине--></basketQTY>
- <originalBasket>string <!--стоимость исходной корзины--></originalBasket>
- <originalCurrency>string <!--валюта заказа--></originalCurrency>
- <orderTotal>string <!--сумма оплаченного заказа--></orderTotal>
- <wmCurrency>string <!--валюта вебмастера--></wmCurrency>
- <commission>string</commission>
- <commissionOpen>string <!--открытая комиссия--></commissionOpen>
- <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
- <commissionApproved>string <!--одобренная комиссия--></commissionApproved>
- <commissionType>string</commissionType>
- <convertedCurrency>string</convertedCurrency>
- <convertedOrderTotal>string</convertedOrderTotal>
- <convertedCommissionOpen>string</convertedCommissionOpen>
- <convertedCommissionCancelled>string</convertedCommissionCancelled>
- <convertedCommissionApproved>string</convertedCommissionApproved>
- <basket> <!--корзина-->
- <item>
- <pid>string <!--ID товара--></pid>
- <product_name>string <!--наименование товара--></product_name>
- <product_category>string <!--категория товара--></product_category>
- <quantity>string <!--количество--></quantity>
- <price>string <!--цена--></price>
</item>
</basket>
</item>
</items>
</data>
</ca.api.webmaster.statistics_orderResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/orderstatistics/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9realtime
Формат:
GET /api/rest/webmaster/xml/realtime/{over_last_few_seconds}/{group_by}
Описание:
Возвращает realtime статистику
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
int | over_last_few_seconds | | | |
enum | group_by | | offer, min, sec | |
Ответ:
- <getRealtimeResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <items>
- <item>
- <time>int</time>
- <hit>int</hit>
- <show>int</show>
- <backurl>int</backurl>
- <event_time>int</event_time>
- <common_open_commission_wm>float</common_open_commission_wm>
- <common_approved_commission_wm>float</common_approved_commission_wm>
- <transactions_count>int</transactions_count>
- <open_submissions_count>int</open_submissions_count>
- <approved_submissions_count>int</approved_submissions_count>
- <offer_id>int</offer_id>
- <offer_name>string</offer_name>
- <click>int</click>
</item>
</items>
</data>
</getRealtimeResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/realtime/600/offer?remote_auth=6420072d37bf14f1df182d0fe0efa2d9