Content

PUT user-language

GET statistics

POST textshift

PUT textshift

API Methods

user-language

Format:

PUT /api/rest/webmaster/xml/user-language

Descritption:

XML PUT-request:

• <setUserLanguageRequestData>
  • <lang>
    en|br|ru|
    </lang>
  </setUserLanguageRequestData>

Response:

• <setUserLanguageResponseData>
  • <status>int</status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>boolean</data>
  </setUserLanguageResponseData>

Example:

http://cityads.com/api/rest/webmaster/xml/user-language?remote_auth=6420072d37bf14f1df182d0fe0efa2d9

statistics

Format:

GET /api/rest/webmaster/xml/statistics/{group_field}/{date_from}/{date_to}?sub_group=<enum>&date_type=<enum>&start=<int>&limit=<int>&q=<string>&request_id=<int>

Descritption:

Input parameters:

Type:	Name:	Description:	Possible values:	Required:
enum	group_field	Offers action_id Types of offers type_offers Verticals category_lvl_1 Categories category_lvl_2 Subcategories category_lvl_3 Offers segment_offer Conversion Types type_actions Payment methods payment_method_id 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 Types tools2 Promo category promo_category Code type code_type Link type link_type Banner size type size_type Banner size promo_size Types points_types Landings points_landings Target pages target_pages Products points_products Promo events points_promo_events Types typesources Referrers referrers Subaccounts subaccount Keywords keyword_se Language language Countries country Regions area Cities city Time zones timezones New and returned new_user Browser browser_type Browser version browser_version Operating System os_type Operating System version os_version Screen Resolution resolution Screen Colors color Device types device_type_id Device models device_id	action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, segment_offer, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_products, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, timezones, new_user, browser_type, browser_version, os_type, os_version, resolution, color, device_type_id, device_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, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_products, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, timezones, new_user, browser_type, browser_version, os_type, os_version, resolution, color, 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	q	search field by the keyword in the main parameter
int	request_id

Response:

• <getStatisticsResponseData>
  • <status>
    200|204|400|403|500|
    </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</actionID>
        • <actionName>string <!--offer name--></actionName>
        • <typeOffers>string</typeOffers>
        • <categoryLvl1>string</categoryLvl1>
        • <categoryLvl2>string</categoryLvl2>
        • <categoryLvl3>string</categoryLvl3>
        • <categoryId>string</categoryId>
        • <isSale>string <!--action type (action or sale)--></isSale>
        • <paymentMethod>string</paymentMethod>
        • <language>string <!--user's language--></language>
        • <timezone>string <!--user's time zone--></timezone>
        • <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>
        • <browser>string</browser>
        • <os>string</os>
        • <keyword>string</keyword>
        • <deviceTypeName>string</deviceTypeName>
        • <deviceName>string</deviceName>
        • <promoEngineName>string <!--instrument name--></promoEngineName>
        • <promoEngineId>int <!--instrument id--></promoEngineId>
        • <feedName>string</feedName>
        • <promoName>string</promoName>
        • <linkName>string</linkName>
        • <promoTypeId>string <!--promo category--></promoTypeId>
        • <promoSizeTypeName>string</promoSizeTypeName>
        • <linkTypeName>string</linkTypeName>
        • <promoSize>string</promoSize>
        • <loadTypeName>string</loadTypeName>
        • <trafficTypeId>string</trafficTypeId>
        • <subaccount>string</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>
        • <browserType>string</browserType>
        • <resolution>string</resolution>
        • <color>string</color>
        • <osType>string</osType>
        • <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>
    • <request_status_in_queue>string</request_status_in_queue>
    </data>
  </getStatisticsResponseData>

Example:

http://cityads.com/api/rest/webmaster/xml/statistics/action_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9

textshift

Format:

POST /api/rest/webmaster/xml/textshift

Descritption:

XML POST-request:

• <createTextShiftRequestData>
  • <name>string</name>
  • <subaccount>string</subaccount>
  • <subaccount1>string</subaccount1>
  • <subaccount2>string</subaccount2>
  • <subaccount3>string</subaccount3>
  • <subaccount4>string</subaccount4>
  • <subaccount5>string</subaccount5>
  • <links>
    on|
    </links>
  • <links_timeout>int</links_timeout>
  • <links_excluded_sites>string</links_excluded_sites>
  • <text>
    on|
    </text>
  • <text_target>
    current|blank|
    </text_target>
  • <text_excluded_sites>string</text_excluded_sites>
  • <clickunder>
    on|
    </clickunder>
  • <clickunder_timeout>int</clickunder_timeout>
  • <clickunder_excluded_sites>string</clickunder_excluded_sites>
  • <clickunder_scheme_first>
    0|1|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_first>
  • <clickunder_scheme_second>
    0|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_second>
  • <clickunder_scheme_third>
    0|3|4|5|6|7|8|9|10|
    </clickunder_scheme_third>
  • <clickunder_target>
    2|3|
    </clickunder_target>
  </createTextShiftRequestData>

Response:

• <createTextShiftResponseData>
  • <status>
    200|204|400|403|500|
    </status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>
    • <id>int</id>
    </data>
  </createTextShiftResponseData>

Example:

http://cityads.com/api/rest/webmaster/xml/textshift?remote_auth=6420072d37bf14f1df182d0fe0efa2d9

textshift

Format:

PUT /api/rest/webmaster/xml/textshift

Descritption:

XML PUT-request:

• <setTextShiftRequestData>
  • <id>int</id>
  • <name>string</name>
  • <subaccount>string</subaccount>
  • <subaccount1>string</subaccount1>
  • <subaccount2>string</subaccount2>
  • <subaccount3>string</subaccount3>
  • <subaccount4>string</subaccount4>
  • <subaccount5>string</subaccount5>
  • <links>
    on|
    </links>
  • <links_timeout>int</links_timeout>
  • <links_excluded_sites>string</links_excluded_sites>
  • <text>
    on|
    </text>
  • <text_target>
    current|blank|
    </text_target>
  • <text_excluded_sites>string</text_excluded_sites>
  • <clickunder>
    on|
    </clickunder>
  • <clickunder_timeout>int</clickunder_timeout>
  • <clickunder_excluded_sites>string</clickunder_excluded_sites>
  • <clickunder_scheme_first>
    0|1|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_first>
  • <clickunder_scheme_second>
    0|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_second>
  • <clickunder_scheme_third>
    0|3|4|5|6|7|8|9|10|
    </clickunder_scheme_third>
  • <clickunder_target>
    2|3|
    </clickunder_target>
  </setTextShiftRequestData>

Response:

• <setTextShiftResponseData>
  • <status>
    200|204|400|403|500|
    </status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>boolean</data>
  </setTextShiftResponseData>

Example:

http://cityads.com/api/rest/webmaster/xml/textshift?remote_auth=6420072d37bf14f1df182d0fe0efa2d9