tools

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

Returns the list of banner sizes

• <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>

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

Returns info about banner's rotators

• <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>

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

Returns info about banner's rotator

• <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>

PUT /api/rest/webmaster/xml/rotator

Change properties of banner rotator

• <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>

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

POST /api/rest/webmaster/xml/rotator

Create banner rotator

• <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>

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

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

Returns list of banners

• <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>

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

Returns list of conversion postback

• <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|google_upload_offline_conversion|microsoft|facebook|
        </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>

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

Returns list of conversion postback

• <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|google_upload_offline_conversion|microsoft|facebook|
      </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>

PUT /api/rest/webmaster/xml/postback

Change conversion postback

• <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|google_upload_offline_conversion|microsoft|facebook|
    </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>

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

POST /api/rest/webmaster/xml/postback

Create conversion postback

• <createPostbackRequestData>
  • <name>string <!--Postback title--></name>
  • <url>string <!--Postback URL--></url>
  • <action_type>
    all|cpl|cpa|
    </action_type>
  • <request_type>
    post|get|google_upload_offline_conversion|microsoft|facebook|
    </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>

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