API Methods
Contents
API methods to retrieve stats data for various data slices. Delayed upload mode for long-time reports is available. In this case the method returns status 204 and an identifier in request_id field. You should set the received request_id in the query as GET param. The Description column of the table shows names of the reports from the publisher’s interface divided into groups.
statistics-offers
Format:
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>
Description:
Retrieves stats data for offers, This method retrieves the list of offers with the data and efficiency for each of them. The list contains offers that showed conversions within the set period of time (from date_from to date_to).
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | start | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
int | request_id | | | |
Response:
- <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 <!--offer id (grouping parameter for group_field=action_id)--></actionID>
- <actionName>string <!--offer name (grouping parameter for group_field=action_id)--></actionName>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <area>string <!--user's region--></area>
- <eventTime>string</eventTime>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <browser>string <!--browser-comment-en--></browser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <categoryId>string <!--category id--></categoryId>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <city>string <!--user's city--></city>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <channelId>int <!--id of channel--></channelId>
- <newUser>string <!--type of user--></newUser>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
- <feedName>string <!--instrument name--></feedName>
- <isSale>string <!--action type (action or sale)--></isSale>
- <language>string <!--user's language--></language>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <linkName>string <!--link name--></linkName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <os>string <!--os-comment-en--></os>
- <osType>string <!--osType-comment-en--></osType>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <productId>string <!--order ID--></productId>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoName>string <!--banner name--></promoName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <keyword>string <!--keyword-comment-en--></keyword>
- <resolution>string <!--resolution-comment-en--></resolution>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <site>string <!--website from which the user came from or preview was made--></site>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <typeOffers>string <!--offer type--></typeOffers>
</item>
</items> - <request_status_in_queue>string</request_status_in_queue>
</data>
</ca.api.webmaster.statistics_offersResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-offers/action_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-segments
Format:
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>
Description:
Retrieves stats data for offer types and business categories. This method retrieves the list of offer types, verticals, categories or sub-categories (depending on the param in the group_field):
- Offer types (efficiency for different offer types)
- Verticals (data for all offer types grouped by 1st level business categories)
- Categories (data for all offer types grouped by 2nd level business categories)
- Subcategories (data for all offer types grouped by 3nd level business categories)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Types of offers |
type_offers |
Verticals |
category_lvl_1 |
Categories |
category_lvl_2 |
Subcategories |
category_lvl_3 |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
enum | date_type |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type (grouping parameter for group_field=type_offers)--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en (grouping parameter for group_field=category_lvl_1)--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en (grouping parameter for group_field=category_lvl_2)--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en (grouping parameter for group_field=category_lvl_3)--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user--></newUser>
- <channelId>int <!--id of channel--></channelId>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_segmentsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-segments/type_offers/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-actions
Format:
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>
Description:
Retrieves stats for conversion types (leads and sales), or for payment methods (depending on the group_field param):
- Conversion types (efficiency for each type of conversions – leads and sales)
- Payment methods (efficiency for various payment methods)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Conversion types |
type_actions |
Payment methods |
payment_method_id |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
enum | date_type |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale) (grouping parameter for group_field=type_actions)--></isSale>
- <paymentMethod>string <!--payment method (grouping parameter for group_field=payment_method_id)--></paymentMethod>
- <language>string <!--user's language--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user--></newUser>
- <channelId>int <!--id of channel--></channelId>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_actionsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-actions/type_actions/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-rate
Format:
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>
Description:
Retrieves data for intensity of conversions for various time periods, seasons, day times, week days or weekends and business days (depending on group_field param):
- Hours (efficiency for each hour from the selected period)
- Days (efficiency for each day from the selected period)
- Weeks (efficiency for each week from the selected period)
- Months (efficiency for each month from the selected period)
- Quarters (efficiency for each quarter from the selected period)
- Years (efficiency for each year from the selected period)
- Seasons (efficiency for each season from the selected period)
- Day time (efficiency depending on the time of day: night – from 0 to 6 a.m.; morning – from 6 to 12 a.m.; day – from 12 to 6 p.m.; evening – from 6 to 0 p.m; efficiency is calculated for all days of the selected period)
- Weekends and business days (efficiency depending on the day of week – Saturday or Sunday; efficiency is calculated for all days of the selected period)
- Days of week (efficiency depending on the days of week: the report contains data for each day of the week from Monday to Sunday; efficiency is calculated for all days of the selected period)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Hours |
event_time_hour |
Days |
event_time_day |
Weeks |
event_time_week |
Months |
event_time_month |
Quarters |
event_time_quarter |
Years |
event_time_year |
Seasons |
seasons |
Time of day |
daytime |
Weekends and weekdays |
weekends |
Weekdays |
weekdays |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
enum | date_type |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language--></language>
- <channelId>int <!--id of channel--></channelId>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user--></newUser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <eventTime>string <!--eventTime-comment-en (grouping parameter for corresponding period)--></eventTime>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <daytime>string</daytime>
- <weekends>string</weekends>
- <weekdays>string</weekdays>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_rateResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-rate/event_time_day/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-entrypoints
Format:
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>
Description:
Retrieves data for the stats of the used tools – by type, category of creative, code formats, link types, banner size types or banner sizes (depending on group_field param):
- Types (efficiency for each type of tools)
- Landing pages, Target pages, Products, etc. (efficiency for each entry point type)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Types |
points_types |
Landings |
points_landings |
Target pages |
target_pages |
Promo events |
points_promo_events |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
enum | date_type |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user--></newUser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en (grouping parameter for group_field=points_types)--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <channelId>int <!--id of channel--></channelId>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_entrypointsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-entrypoints/points_types/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-sources
Format:
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>
Description:
Retrieves stats for traffic sources – by traffic type, referrers, sub-accounts or keywords (depending on group_field param):
- Types (efficiency for each type of traffic, for example, social networks)
- Referrers (efficiency for each referrer – websites from which the users go to the publisher’s website)
- Sub-accounts (efficiency for subaccounts – user marks used to categorize traffic)
- Keywords (efficiency for keywords)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Types |
typesources |
Referrers |
referrers |
Subaccounts |
subaccount |
Keywords |
keyword_se |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | start | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user--></newUser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en (grouping parameter for group_field=keyword_se)--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en (grouping parameter for group_field=typesources)--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en (grouping parameter for group_field=subaccount)--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made (grouping parameter for group_field=referrers)--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <channelId>int <!--id of channel--></channelId>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_sourcesResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-sources/typesources/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-geo
Format:
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>
Description:
Retrieves stats by geographical location – language, country, region, time zones (depending on group_field param):
- Language (efficiency for user languages)
- Unions (efficiency for country unions from which the conversions came)
- Countries (efficiency for countries from which the conversions came)
- Regions (efficiency for regions from which the conversions came)
- Towns (efficiency for towns from which the conversions came)
- Time zones (efficiency for time zones from which the conversions came)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Language |
language |
Countries |
country |
Regions |
area |
Cities |
city |
Time zones |
timezones |
Community of Countries |
commonwealth |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
enum | date_type |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language (grouping parameter for group_field=language)--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community (grouping parameter for group_field=commonwealth)--></commonwealth>
- <country>string <!--user's country (grouping parameter for group_field=country)--></country>
- <area>string <!--user's region (grouping parameter for group_field=area)--></area>
- <city>string <!--user's city (grouping parameter for group_field=city)--></city>
- <newUser>string <!--type of user--></newUser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <channelId>int <!--id of channel--></channelId>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_geoResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-geo/language/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-behaviour
Format:
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>
Description:
Retrieves data for user behavior – new and returning users:
- New and returning (efficiency for new and returning users)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
New and returned |
new_user |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
enum | date_type |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user (grouping parameter for group_field=new_user)--></newUser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <channelId>int <!--id of channel--></channelId>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_behaviourResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-behaviour/new_user/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-technologies
Format:
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>
Description:
Retrieves stats for technology – browsers, browser versions, OS, OS versions, screen resolutions or colours (depending on group_field param):
- Browser (efficiency for user browsers)
- Browser version (efficiency for user browser versions)/li>
- OS (efficiency for different user OSs)
- OS version (efficiency for different user OS versions)
- Screen resolution (efficiency for different user screen resolutions)
- Screen colours (efficiency for different user screen colours)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Browser |
browser_type |
Browser version |
browser_version |
Operating System |
os_type |
Operating System version |
os_version |
Screen Resolution |
resolution |
Screen Colors |
color |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
enum | date_type |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user--></newUser>
- <browserType>string <!--browserType-comment-en (grouping parameter for group_field=browser_type)--></browserType>
- <browser>string <!--browser-comment-en (grouping parameter for group_field=browser_version)--></browser>
- <osType>string <!--osType-comment-en (grouping parameter for group_field=os_type)--></osType>
- <os>string <!--os-comment-en (grouping parameter for group_field=os_version)--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en (grouping parameter for group_field=resolution)--></resolution>
- <channelId>int <!--id of channel--></channelId>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_technologiesResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-technologies/os_type/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-channels
Format:
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>
Description:
Retrieves stats data for channels, This method retrieves the list of channels with the data and efficiency for each of them. The list contains channels that showed conversions within the set period of time (from date_from to date_to).
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | start | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
int | request_id | | | |
Response:
- <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 <!--offer id (grouping parameter for group_field=action_id)--></actionID>
- <actionName>string <!--offer name (grouping parameter for group_field=action_id)--></actionName>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <area>string <!--user's region--></area>
- <eventTime>string</eventTime>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <browser>string <!--browser-comment-en--></browser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <categoryId>string <!--category id--></categoryId>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <city>string <!--user's city--></city>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <channelId>int <!--id of channel--></channelId>
- <newUser>string <!--type of user--></newUser>
- <deviceName>string <!--deviceName-comment-en--></deviceName>
- <deviceTypeName>string <!--deviceTypeName-comment-en--></deviceTypeName>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
- <feedName>string <!--instrument name--></feedName>
- <isSale>string <!--action type (action or sale)--></isSale>
- <language>string <!--user's language--></language>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <linkName>string <!--link name--></linkName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <os>string <!--os-comment-en--></os>
- <osType>string <!--osType-comment-en--></osType>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <productId>string <!--order ID--></productId>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoName>string <!--banner name--></promoName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <keyword>string <!--keyword-comment-en--></keyword>
- <resolution>string <!--resolution-comment-en--></resolution>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <site>string <!--website from which the user came from or preview was made--></site>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <typeOffers>string <!--offer type--></typeOffers>
</item>
</items> - <request_status_in_queue>string</request_status_in_queue>
</data>
</ca.api.webmaster.statistics_channelsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-channels/channel_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9statistics-devices
Format:
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>
Description:
Retrieves stats for user devices – types or models (depending on group_field param):
- Device type (efficiency for different device types)
- Device model (efficiency for different device models)
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
enum | group_field |
Device types |
device_type_id |
Mobile device models |
mobile_device |
| |
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter for making groups by special fields | 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 |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | start | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
int | request_id | | | |
Response:
- <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 <!--offer id--></actionID>
- <actionName>string <!--offer name--></actionName>
- <typeOffers>string <!--offer type--></typeOffers>
- <categoryLvl1>string <!--categoryLvl1-comment-en--></categoryLvl1>
- <categoryLvl2>string <!--categoryLvl2-comment-en--></categoryLvl2>
- <categoryLvl3>string <!--categoryLvl3-comment-en--></categoryLvl3>
- <categoryId>string <!--category id--></categoryId>
- <isSale>string <!--action type (action or sale)--></isSale>
- <paymentMethod>string <!--payment method--></paymentMethod>
- <language>string <!--user's language--></language>
- <eventTime>string</eventTime>
- <commonwealth>string <!--user's community--></commonwealth>
- <country>string <!--user's country--></country>
- <area>string <!--user's region--></area>
- <city>string <!--user's city--></city>
- <newUser>string <!--type of user--></newUser>
- <browserType>string <!--browserType-comment-en--></browserType>
- <browser>string <!--browser-comment-en--></browser>
- <osType>string <!--osType-comment-en--></osType>
- <os>string <!--os-comment-en--></os>
- <keyword>string <!--keyword-comment-en--></keyword>
- <deviceTypeName>string <!--deviceTypeName-comment-en (grouping parameter for group_field=device_type_id)--></deviceTypeName>
- <deviceName>string <!--deviceName-comment-en (grouping parameter for group_field=device_id)--></deviceName>
- <promoEngineName>string <!--instrument name--></promoEngineName>
- <promoEngineId>int <!--instrument id--></promoEngineId>
- <feedName>string <!--instrument name--></feedName>
- <promoName>string <!--banner name--></promoName>
- <linkName>string <!--link name--></linkName>
- <promoTypeId>string <!--promo category--></promoTypeId>
- <promoSizeTypeName>string <!--promoSizeTypeName-comment-en--></promoSizeTypeName>
- <linkTypeName>string <!--linkTypeName-comment-en--></linkTypeName>
- <promoSize>string <!--promoSize-comment-en--></promoSize>
- <loadTypeName>string <!--loadTypeName-comment-en--></loadTypeName>
- <trafficTypeId>string <!--trafficTypeId-comment-en--></trafficTypeId>
- <subaccount>string <!--subaccount-comment-en--></subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <site>string <!--website from which the user came from or preview was made--></site>
- <productId>string <!--order ID--></productId>
- <resolution>string <!--resolution-comment-en--></resolution>
- <channelId>int <!--id of channel--></channelId>
- <showCount>int <!--number of demonstrations of promotional material to unique user--></showCount>
- <clickCount>int <!--non-unique pass on promotional material--></clickCount>
- <clickUniqCount>int <!--unique pass on promotional material--></clickUniqCount>
- <backUrlRedirectCount>int <!--number of redirections. backurl--></backUrlRedirectCount>
- <leadsOpen>int <!--number of public leads--></leadsOpen>
- <leadsCancelled>int <!--number of rejected leads--></leadsCancelled>
- <leadsApproved>int <!--number of confirmed leads--></leadsApproved>
- <saleOpen>int <!--number of open sales--></saleOpen>
- <saleCancelled>int <!--number of rejected sales--></saleCancelled>
- <saleApproved>int <!--number of confirmed sales--></saleApproved>
- <commissionOpen>string <!--open commission--></commissionOpen>
- <commissionCancelled>string <!--rejected commission--></commissionCancelled>
- <commissionApproved>string <!--confirmed commission--></commissionApproved>
- <crLeads>string <!--ratio of total number of actions to total number of clicks--></crLeads>
- <crSales>string <!--ratio of total number of sales to total number of clicks--></crSales>
- <crTotal>string <!--ratio of total number of actions and sales to total number of clicks--></crTotal>
- <arLeads>string <!--ratio of total number of confirmed actions to total number of leads--></arLeads>
- <arSales>string <!--ratio of total number of confirmed sales to total number of sales--></arSales>
- <arTotal>string <!--ratio of total number of confirmed sales and actions to total number of sales and actions--></arTotal>
- <arCommission>string <!--ratio of confirmed commission to the amount of open, confirmed and rejected commission--></arCommission>
- <ctr>string <!--click-through rate (percent of clicks per one demonstration)--></ctr>
- <ecpc>string <!--average cost of click--></ecpc>
- <ecpm>string <!--income from 1000 advertising material demonstrations--></ecpm>
</item>
</items>
</data>
</ca.api.webmaster.statistics_devicesResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/statistics-devices/device_type_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9orderstatistics
Format:
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>
Description:
Retrieves order stats for the selected period
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
date | date_from | report view period start date | | |
date | date_to | report view period finish date | | |
enum | sub_group | additional parameter to make grouping | 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 |
By conversion date |
conversion |
By upload date |
order_upload |
| conversion, order_upload | |
int | start | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
string | action_id | | | |
int | channel_id | id of channel | | |
string | q | search field by the keyword in the main parameter | | |
string | xid | | | |
int | request_id | request number | | |
boolean | show_detailed_basket | shopping cart details | | |
string | currency_code | currency to be converted into, webmaster's currency by default | | |
Response:
- <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> <!--action type-->
sale|lead|Sale|Lead|Продажа|Лид|Venda|Venta|Petunjuk|Jualan|Lead|Transakcja|促销|
</conversion> - <orderID>string</orderID>
- <submissionID>string</submissionID>
- <xid>string</xid>
- <subaccount>string</subaccount>
- <subaccount2>string</subaccount2>
- <subaccount3>string</subaccount3>
- <subaccount4>string</subaccount4>
- <subaccount5>string</subaccount5>
- <clickTime>string <!--date and time of click-through the advertising link--></clickTime>
- <leadTime>string <!--conversion date and time--></leadTime>
- <saleTime>string <!--objective fulfilment date and time--></saleTime>
- <leadDelta>string <!--time difference between the date of click-through the advertising link and conversion--></leadDelta>
- <saleDelta>string <!--time difference between conversion and objective fulfilment--></saleDelta>
- <totalDelta>string <!--time difference between the date of click-through the advertising link and objective fulfilment--></totalDelta>
- <offerID>string</offerID>
- <offerName>string</offerName>
- <campaignTargetName>string</campaignTargetName>
- <country>string</country>
- <area>string</area>
- <city>string</city>
- <newUser>string</newUser>
- <browserType>string</browserType>
- <browser>string</browser>
- <osType>string</osType>
- <os>string</os>
- <keyword>string</keyword>
- <deviceTypeName>string</deviceTypeName>
- <deviceName>string</deviceName>
- <promoEngineName>string</promoEngineName>
- <promoEngineId>int</promoEngineId>
- <channelId>int <!--id of channel--></channelId>
- <language>string</language>
- <site>string</site>
- <status>string</status>
- <customerType>string</customerType>
- <paymentMethod>string</paymentMethod>
- <basketQTY>string <!--number of articles in shopping cart--></basketQTY>
- <originalBasket>string</originalBasket>
- <originalCurrency>string <!--order currency--></originalCurrency>
- <orderTotal>string <!--total amount of order--></orderTotal>
- <wmCurrency>string <!--webmaster currency--></wmCurrency>
- <commission>string</commission>
- <commissionOpen>string</commissionOpen>
- <commissionCancelled>string</commissionCancelled>
- <commissionApproved>string</commissionApproved>
- <commissionType>string</commissionType>
- <convertedCurrency>string <!--currency from "currency_code" parameter or webmaster's currency by default--></convertedCurrency>
- <convertedOrderTotal>string</convertedOrderTotal>
- <convertedCommissionOpen>string</convertedCommissionOpen>
- <convertedCommissionCancelled>string</convertedCommissionCancelled>
- <convertedCommissionApproved>string</convertedCommissionApproved>
- <basket> <!--shopping cart-->
- <item>
- <pid>string <!--product ID--></pid>
- <product_name>string <!--product name--></product_name>
- <product_category>string <!--product category--></product_category>
- <quantity>string <!--quantity--></quantity>
- <price>string <!--price--></price>
</item>
</basket>
</item>
</items>
</data>
</ca.api.webmaster.statistics_orderResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/orderstatistics/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9realtime
Format:
GET /api/rest/webmaster/xml/realtime/{over_last_few_seconds}/{group_by}
Description:
Returns realtime stat
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | over_last_few_seconds | | | |
enum | group_by | | offer, min, sec | |
Response:
- <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>
Example:
http://cityads.com/api/rest/webmaster/xml/realtime/600/offer?remote_auth=6420072d37bf14f1df182d0fe0efa2d9