Developers

tools

API Methods

banner-sizes-list
Format:

GET /api/rest/webmaster/xml/banner-sizes-list

Descritption:

Returns the list of banner sizes

Input parameters:
Response:
  • <getBannerSizesResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        </item>
      </data>
    </getBannerSizesResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/banner-sizes-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
rotators
Format:

GET /api/rest/webmaster/xml/rotators?start=<int>&limit=<int>

Descritption:

Returns info about banner's rotators

Input parameters:
Type:Name:Description:Possible values:Required:
intstart
 
intlimit
 
Response:
  • <getRotatorsResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <total>int</total>
      • <items>
        • <item>
          • <id>int</id>
          • <name>string</name>
          • <subaccount>string</subaccount>
          • <added_at>dateTime</added_at>
          • <type>
              flash|image|all|
            </type>
          • <offers_included>
            • <item>
              • <id>int</id>
              • <name>string</name>
              </item>
            </offers_included>
          • <offers_excluded>
            • <item>
              • <id>int</id>
              • <name>string</name>
              </item>
            </offers_excluded>
          • <add_new_offers>
              0|1|
            </add_new_offers>
          • <banner_sizes>
            • <item>string</item>
            </banner_sizes>
          • <category_included>
            • <item>
              • <id>int</id>
              • <name>string</name>
              </item>
            </category_included>
          • <category_excluded>
            • <item>
              • <id>int</id>
              • <name>string</name>
              </item>
            </category_excluded>
          • <banners_included>
            • <item>
              • <id>int</id>
              • <name>string</name>
              </item>
            </banners_included>
          • <banners_excluded>
            • <item>
              • <id>int</id>
              • <name>string</name>
              </item>
            </banners_excluded>
          • <enable_optimization>
              0|1|
            </enable_optimization>
          • <code>
            • <item>
              • <value>string</value>
              • <type>
                  JS_CODE|JS_CODE_ASYNC|XML_FEED|
                </type>
              </item>
            </code>
          </item>
        </items>
      </data>
    </getRotatorsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotators?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
rotator
Format:

GET /api/rest/webmaster/xml/rotator/{id}

Descritption:

Returns info about banner's rotator

Input parameters:
Type:Name:Description:Possible values:Required:
intid
 
Response:
  • <getRotatorResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <id>int</id>
      • <name>string</name>
      • <subaccount>string</subaccount>
      • <added_at>dateTime</added_at>
      • <type>
          flash|image|all|
        </type>
      • <offers_included>
        • <item>
          • <id>int</id>
          • <name>string</name>
          </item>
        </offers_included>
      • <offers_excluded>
        • <item>
          • <id>int</id>
          • <name>string</name>
          </item>
        </offers_excluded>
      • <add_new_offers>
          0|1|
        </add_new_offers>
      • <banner_sizes>
        • <item>string</item>
        </banner_sizes>
      • <category_included>
        • <item>
          • <id>int</id>
          • <name>string</name>
          </item>
        </category_included>
      • <category_excluded>
        • <item>
          • <id>int</id>
          • <name>string</name>
          </item>
        </category_excluded>
      • <banners_included>
        • <item>
          • <id>int</id>
          • <name>string</name>
          </item>
        </banners_included>
      • <banners_excluded>
        • <item>
          • <id>int</id>
          • <name>string</name>
          </item>
        </banners_excluded>
      • <enable_optimization>
          0|1|
        </enable_optimization>
      • <code>
        • <item>
          • <value>string</value>
          • <type>
              JS_CODE|JS_CODE_ASYNC|XML_FEED|
            </type>
          </item>
        </code>
      </data>
    </getRotatorResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotator?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
rotator
Format:

PUT /api/rest/webmaster/xml/rotator

Descritption:

Change properties of banner rotator

XML PUT-request:
  • <setRotatorRequestData>
    • <id>int</id>
    • <name>string</name>
    • <subaccount>string</subaccount>
    • <type>
        flash|image|all|
      </type>
    • <offers_included>
      • <item>int</item>
      </offers_included>
    • <offers_excluded>
      • <item>int</item>
      </offers_excluded>
    • <add_new_offers>
        0|1|
      </add_new_offers>
    • <banner_sizes>
      • <item>string</item>
      </banner_sizes>
    • <category_included>
      • <item>int</item>
      </category_included>
    • <category_excluded>
      • <item>int</item>
      </category_excluded>
    • <banners_included>
      • <item>int</item>
      </banners_included>
    • <banners_excluded>
      • <item>int</item>
      </banners_excluded>
    • <enable_optimization>
        0|1|
      </enable_optimization>
    </setRotatorRequestData>
Response:
  • <setRotatorResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>boolean</data>
    </setRotatorResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotator?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
rotator
Format:

POST /api/rest/webmaster/xml/rotator

Descritption:

Create banner rotator

XML POST-request:
  • <createRotatorRequestData>
    • <name>string</name>
    • <subaccount>string</subaccount>
    • <type>
        flash|image|all|
      </type>
    • <offers_included>
      • <item>int</item>
      </offers_included>
    • <offers_excluded>
      • <item>int</item>
      </offers_excluded>
    • <add_new_offers>
        0|1|
      </add_new_offers>
    • <banner_sizes>
      • <item>string</item>
      </banner_sizes>
    • <category_included>
      • <item>int</item>
      </category_included>
    • <category_excluded>
      • <item>int</item>
      </category_excluded>
    • <banners_included>
      • <item>int</item>
      </banners_included>
    • <banners_excluded>
      • <item>int</item>
      </banners_excluded>
    • <enable_optimization>
        0|1|
      </enable_optimization>
    </createRotatorRequestData>
Response:
  • <createRotatorResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <id>int</id>
      </data>
    </createRotatorResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotator?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
textshift
Format:

POST /api/rest/webmaster/xml/textshift

Descritption:

Create Text SHift

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:

Change properties of Text Shift

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
banners
Format:

GET /api/rest/webmaster/xml/banners?start=<int>&limit=<int>&term=<string>

Descritption:

Returns list of banners

Input parameters:
Type:Name:Description:Possible values:Required:
intstart
 
intlimit
 
stringtermsearch field by the keyword in the offer's title or promo's title
 
Response:
  • <getBannersResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        </item>
      </data>
    </getBannersResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/banners?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
postback-list
Format:

GET /api/rest/webmaster/xml/postback-list?start=<int>&limit=<int>&term=<string>

Descritption:

Returns list of conversion postback

Input parameters:
Type:Name:Description:Possible values:Required:
intstart
 
intlimit
 
stringterm
 
Response:
  • <getPostbacksResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        • <url>string</url>
        • <action_type>
            0|cpl|cpa|
          </action_type>
        • <request_type>
            post|get|
          </request_type>
        • <status>
            1|2|3|
          </status>
        • <comment>string</comment>
        • <query_params>
          • <item>
            • <name>string</name>
            • <value>string</value>
            </item>
          </query_params>
        • <offers_included>
          • <item>int</item>
          </offers_included>
        </item>
      </data>
    </getPostbacksResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
postback
Format:

GET /api/rest/webmaster/xml/postback?id=<int>

Descritption:

Returns list of conversion postback

Input parameters:
Type:Name:Description:Possible values:Required:
intid
 
Response:
  • <getPostbackResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <id>int</id>
      • <name>string</name>
      • <url>string</url>
      • <action_type>
          0|cpl|cpa|
        </action_type>
      • <request_type>
          post|get|
        </request_type>
      • <status>
          1|2|3|
        </status>
      • <comment>string</comment>
      • <query_params>
        • <item>
          • <name>string</name>
          • <value>string</value>
          </item>
        </query_params>
      • <offers_included>
        • <item>int</item>
        </offers_included>
      </data>
    </getPostbackResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
postback
Format:

PUT /api/rest/webmaster/xml/postback

Descritption:

Change conversion postback

XML PUT-request:
  • <setPostbackRequestData>
    • <id>int</id>
    • <name>string <!--Postback title--></name>
    • <url>string <!--Postback URL--></url>
    • <action_type>
        all|cpl|cpa|
      </action_type>
    • <request_type>
        post|get|
      </request_type>
    • <query_params> <!--Allowed string that match by regexp /^[a-z0-9_]+$/i-->
      • <offer_id>string</offer_id>
      • <offer_name>string</offer_name>
      • <wp_id>string</wp_id>
      • <wp_name>string</wp_name>
      • <site>string</site>
      • <subaccount>string</subaccount>
      • <action_type>string</action_type>
      • <target_id>string</target_id>
      • <target_name>string</target_name>
      • <payout_id>string</payout_id>
      • <payout>string</payout>
      • <payout_currency>string</payout_currency>
      • <click_id>string</click_id>
      • <click_time>string</click_time>
      • <event_time>string</event_time>
      • <conversion_time>string</conversion_time>
      • <ip>string</ip>
      • <country>string</country>
      • <city>string</city>
      • <ua>string</ua>
      • <user_browser>string</user_browser>
      • <user_os>string</user_os>
      • <user_device>string</user_device>
      • <cpl_id>string</cpl_id>
      • <open_commission>string</open_commission>
      • <order_amount>string</order_amount>
      • <status>string</status>
      </query_params>
    • <offers_included> <!--List of included offers (if you put empty list then current included offers will be removed from this postback. If array contains 0 then all available offers will included-->
      • <item>int</item>
      </offers_included>
    </setPostbackRequestData>
Response:
  • <setPostbackResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>boolean</data>
    </setPostbackResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
postback
Format:

POST /api/rest/webmaster/xml/postback

Descritption:

Create conversion postback

XML POST-request:
  • <createPostbackRequestData>
    • <name>string <!--Postback title--></name>
    • <url>string <!--Postback URL--></url>
    • <action_type>
        all|cpl|cpa|
      </action_type>
    • <request_type>
        post|get|
      </request_type>
    • <query_params> <!--Allowed string that match by regexp /^[a-z0-9_]+$/i-->
      • <offer_id>string</offer_id>
      • <offer_name>string</offer_name>
      • <wp_id>string</wp_id>
      • <wp_name>string</wp_name>
      • <site>string</site>
      • <subaccount>string</subaccount>
      • <action_type>string</action_type>
      • <target_id>string</target_id>
      • <target_name>string</target_name>
      • <payout_id>string</payout_id>
      • <payout>string</payout>
      • <payout_currency>string</payout_currency>
      • <click_id>string</click_id>
      • <click_time>string</click_time>
      • <event_time>string</event_time>
      • <conversion_time>string</conversion_time>
      • <ip>string</ip>
      • <country>string</country>
      • <city>string</city>
      • <ua>string</ua>
      • <user_browser>string</user_browser>
      • <user_os>string</user_os>
      • <user_device>string</user_device>
      • <cpl_id>string</cpl_id>
      • <open_commission>string</open_commission>
      • <order_amount>string</order_amount>
      • <status>string</status>
      </query_params>
    • <offers_included> <!--List of included offers (if you put empty list then current included offers will be removed from this postback. If array contains 0 then all available offers will included-->
      • <item>int</item>
      </offers_included>
    </createPostbackRequestData>
Response:
  • <createPostbackResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <id>int</id>
      </data>
    </createPostbackResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback?remote_auth=6420072d37bf14f1df182d0fe0efa2d9