Developers

offers

API Methods

offers
Format:

GET /api/rest/webmaster/xml/offers/{type}?start=<int>&limit=<int>&sort=<enum>&sort_type=<enum>&q=<string>&geo=<string>&platforms=<string>&categories=<string>&traffic_types=<string>&traffic_channel_id=<int>&shop_id=<string>&linksonly=<enum>&user_has_offer=<enum>&tools=<string>

Descritption:

Returns the list of offers. The list contains: information on lead commissions and sale, webmaster's income data for each offer. Received offers' identifiers can be used in scenarios involving other methods of API

Input parameters:
Type:Name:Description:Possible values:Required:
enumtypeoffer type. See offers' types guideweb, web_favourite, mobile, mobile_favourite, all, all_favourite
 
intstartnumber of current page. 0 by default
 
intlimitnumber of elements per page. 50 by default, 1000 maximum
 
enumsortsort by fieldid, name, rating, cpl, cpa, epc7days, epc90days, cpo7days, cpo90days
 
enumsort_typesort orderasc, desc
 
stringqsearch field by the keyword in the offer's title
 
stringgeofilter by region. Integer identifiers shall be listed separated by commas. See regions guide
 
stringplatformsfilter by mobile platforms. Integer identifiers shall be listed separated by commas. See mobile platforms guide
 
stringcategoriesfilter by categories. Integer identifiers shall be listed separated by commas. See offers' categories guide
 
stringtraffic_typesfilter by traffic type. Integer identifiers shall be listed separated by commas. See Traffic types guide
 
inttraffic_channel_idfilter by traffic channels. Integer identifiers shall be listed separated by commas.
 
stringshop_idstore identifier in goods catalogue. See Goods catalogue
 
enumlinksonlyget links of offers without statistics datatrue, false
 
enumuser_has_offerAvailability of offer for webmastertrue, false
 
stringtoolsfilter by tools. nteger identifiers shall be listed separated by commas. See. tools guide
 
Response:
  • <getOffersResponseData>
    • <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 <!--offer title--></name>
          • <user_has_offer> <!--Availability of offer for webmaster-->
              0|1|
            </user_has_offer>
          • <cookie_ltv>string <!--Cookies life span--></cookie_ltv>
          • <site>string <!--Offer site--></site>
          • <categories> <!--Offers categories-->
            • <item>
              • <main_id>int <!--Id of main category--></main_id>
              • <main_title>string <!--Name of main category--></main_title>
              • <other_categories> <!--other categories-->
                • <item>
                  • <id>int</id>
                  • <title>string</title>
                  </item>
                </other_categories>
              </item>
            </categories>
          • <traffic-types>
            • <item>
              • <id>int <!--id типа траффика--></id>
              • <value>boolean <!--доступен/недоступен--></value>
              • <note>string <!--описание--></note>
              • <name>string <!--название типа траффика--></name>
              </item>
            </traffic-types>
          • <geo> <!--Offers regions-->
            • <item>
              • <id>int <!--id региона--></id>
              • <name>string <!--название региона--></name>
              • <country_id>string <!--код страны--></country_id>
              • <area_id>string <!--area_id--></area_id>
              • <code>string <!--код из браузера--></code>
              • <iso>string <!--код по iso--></iso>
              • <parent_id>string <!--id родителя--></parent_id>
              • <city_id>string <!--city_id--></city_id>
              • <timezone>string <!--часовой пояс--></timezone>
              </item>
            </geo>
          • <items> <!--list of offer's links-->
            • <item>
              • <title>string</title>
              • <is_default>string</is_default>
              • <deep_link>string</deep_link>
              </item>
            </items>
          • <favicon>string</favicon>
          • <shop_id>string</shop_id>
          • <cpl>string <!--Lead Commission--></cpl>
          • <cpa>string <!--Sale Commission--></cpa>
          • <rating>float</rating>
          • <epc7days>string <!--Webmaster income from 1000 clicks in one week--></epc7days>
          • <epc90days>string <!--Webmaster income from 1000 clicks in three months--></epc90days>
          • <cpo7days>string</cpo7days>
          • <cpo90days>string</cpo90days>
          • <screen>string <!--Site screenshot--></screen>
          </item>
        </items>
      </data>
    </getOffersResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offers/web?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
promo
Format:

GET /api/rest/webmaster/xml/promo/{offer_id}?traffic_channel_id=<int>&start=<int>&limit=<int>

Descritption:

Returns the directory of offer Promo

Input parameters:
Type:Name:Description:Possible values:Required:
intoffer_id
 
inttraffic_channel_idfilter by traffic channels. Integer identifier.
 
intstartnumber of current page. 0 by default
 
intlimitnumber of elements per page. 50 by default, 1000 maximum
 
Response:
  • <getPromoResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <total>int</total>
      • <items>
        • <item>
          • <id>int</id>
          • <offer_id>int</offer_id>
          • <name>string</name>
          • <added_at>string</added_at>
          • <promo_type>string</promo_type>
          • <size>string</size>
          • <thumbnail>string</thumbnail>
          • <file>string</file>
          • <url>string</url>
          • <promo_code>string</promo_code>
          • <promo_code_asynchron>string</promo_code_asynchron>
          </item>
        </items>
      </data>
    </getPromoResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/promo/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offer
Format:

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

Descritption:

Returns detail information about an offer

Input parameters:
Type:Name:Description:Possible values:Required:
intidoffer identifier
 
Response:
  • <getOfferResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <id>int</id>
      • <name>string</name>
      • <site_url>string</site_url>
      • <date_start>string</date_start>
      • <rating>float</rating>
      • <text>string</text>
      • <geo>
        • <item>
          • <id>int</id>
          • <code>string</code>
          • <title>string</title>
          </item>
        </geo>
      • <traffic-types>
        • <item>
          • <value>boolean</value>
          • <note>string</note>
          • <name>string</name>
          </item>
        </traffic-types>
      • <terms_paid_search>
        • <item>
          • <value>boolean</value>
          • <note>string</note>
          • <name>string</name>
          </item>
        </terms_paid_search>
      • <terms_transactions>
        • <item>
          • <value>boolean</value>
          • <note>string</note>
          • <name>string</name>
          </item>
        </terms_transactions>
      • <terms_notice_periods>
        • <item>
          • <note>string</note>
          • <name>string</name>
          • <day>int</day>
          </item>
        </terms_notice_periods>
      </data>
    </getOfferResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offer/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offertarget
Format:

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

Descritption:

Returns a list of offer goals and corresponding payments

Input parameters:
Type:Name:Description:Possible values:Required:
intidoffer identifier
 
Response:
  • <getOfferTargetResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <items>
        • <item>
          • <id>int</id>
          • <service_area>
            • <item>
              • <id>int <!--geo id--></id>
              • <code>string <!--geo code--></code>
              • <title>string <!--geo title--></title>
              </item>
            </service_area>
          • <restriction_on_geo>
            • <item>
              • <id>int <!--geo id--></id>
              • <code>string <!--geo code--></code>
              • <title>string <!--geo title--></title>
              </item>
            </restriction_on_geo>
          • <title>string</title>
          • <cpl>string</cpl>
          • <cps>string</cps>
          • <is_personal>boolean</is_personal>
          </item>
        </items>
      </data>
    </getOfferTargetResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offertarget/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-audience
Format:

GET /api/rest/webmaster/xml/analytics-audience/{site}/{months}

Descritption:

Summary data for the web-site

Input parameters:
Type:Name:Description:Possible values:Required:
stringsite
 
enummonths1, 3, 6, 12
 
Response:
  • <getAnalyticsAudienceResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <average>
        • <average_visits_per_day>int</average_visits_per_day>
        • <average_time_on_site>string</average_time_on_site>
        • <average_page_views>string</average_page_views>
        • <average_bounce_rate>string</average_bounce_rate>
        </average>
      • <ranking>
        • <global_rank>int</global_rank>
        • <country>string</country>
        • <country_rank>int</country_rank>
        • <category>string</category>
        • <category_rank>int</category_rank>
        </ranking>
      • <audience-startdate>string</audience-startdate>
      • <audience-reach>
        • <item>string</item>
        </audience-reach>
      • <audience-time>
        • <item>string</item>
        </audience-time>
      • <audience-pages>
        • <item>string</item>
        </audience-pages>
      • <audience-bounce>
        • <item>string</item>
        </audience-bounce>
      </data>
    </getAnalyticsAudienceResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/analytics-audience/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-geo
Format:

GET /api/rest/webmaster/xml/analytics-geo/{site}/{months}

Descritption:

Correlation of traffic to different countries

Input parameters:
Type:Name:Description:Possible values:Required:
stringsite
 
enummonths1, 3, 6, 12
 
Response:
  • <getAnalyticsGeoResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <countries>
        • <item>
          • <country>string</country>
          • <share>string</share>
          </item>
        </countries>
      </data>
    </getAnalyticsGeoResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/analytics-geo/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-input-traffic
Format:

GET /api/rest/webmaster/xml/analytics-input-traffic/{site}/{months}

Descritption:

Analytics for inbound traffic

Input parameters:
Type:Name:Description:Possible values:Required:
stringsite
 
enummonths1, 3, 6, 12
 
Response:
analytics-outgoing-traffic
Format:

GET /api/rest/webmaster/xml/analytics-outgoing-traffic/{site}/{months}

Descritption:

Analytics for outbound traffic

Input parameters:
Type:Name:Description:Possible values:Required:
stringsite
 
enummonths1, 3, 6, 12
 
Response:
  • <getAnalyticsOutgoingTrafficResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <icon>string</icon>
        • <domain>string</domain>
        • <rank>string</rank>
        • <share>string</share>
        • <change>string</change>
        </item>
      </data>
    </getAnalyticsOutgoingTrafficResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/analytics-outgoing-traffic/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-similar-sites
Format:

GET /api/rest/webmaster/xml/analytics-similar-sites/{site}

Descritption:

List of similar advertisers

Input parameters:
Type:Name:Description:Possible values:Required:
stringsite
 
Response:
  • <getAnalyticsSimilarSitesResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <domain>string</domain>
        • <category>string</category>
        • <global-rank>int</global-rank>
        • <score>string</score>
        </item>
      </data>
    </getAnalyticsSimilarSitesResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/analytics-similar-sites/aliexpress.com?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-competitors
Format:

GET /api/rest/webmaster/xml/analytics-competitors/{site}

Descritption:

List of competitors in search engines

Input parameters:
Type:Name:Description:Possible values:Required:
stringsite
 
Response:
  • <getAnalyticsCompetitorsResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <domain>string</domain>
        • <category>string</category>
        • <global-rank>int</global-rank>
        • <score>string</score>
        </item>
      </data>
    </getAnalyticsCompetitorsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/analytics-competitors/aliexpress.com?remote_auth=6420072d37bf14f1df182d0fe0efa2d9