API Methods
offers
Format:
GET /api/rest/webmaster/xml/offers/{type}?ids=<string>&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>&is_exclusive=<boolean>&tags=<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: |
---|
enum | type | offer type. See offers' types guide | web, web_favourite, mobile, mobile_favourite, api, api_favourite, all, all_favourite | |
string | ids | offer id. Integer identifiers shall be listed separated by commas. | | |
int | start | number of current page. 0 by default | | |
int | limit | number of elements per page. 50 by default, 1000 maximum | | |
enum | sort | sort by field | id, name, rating, cpl, cpa, epc7days, epc90days, cpo7days, cpo90days | |
enum | sort_type | sort order | asc, desc | |
string | q | search field by the keyword in the offer's title | | |
string | geo | filter by region. Integer identifiers shall be listed separated by commas. See regions guide | | |
string | platforms | filter by mobile platforms. Integer identifiers shall be listed separated by commas. See mobile platforms guide | | |
string | categories | filter by categories. Integer identifiers shall be listed separated by commas. See offers' categories guide | | |
string | traffic_types | filter by traffic type. Integer identifiers shall be listed separated by commas. See traffic types guide | | |
int | traffic_channel_id | filter by traffic channels. Integer identifier. See traffic channels guide | | |
string | shop_id | store identifier in goods catalogue. See goods catalogue | | |
enum | linksonly | get links of offers without statistics data | true, false | |
enum | user_has_offer | availability of offer for webmaster | true, false | |
string | tools | filter by tools. Integer identifiers shall be listed separated by commas. See tools guide | | |
boolean | is_exclusive | shows whether CityAds has exclusive conditions for the offer | | |
string | tags | custom labels of the offer. String codes shall be listed separated by commas. See tags guide | | |
Response:
- <getOffersResponseData>
- <status></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--></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> - <additional-traffic-types> <!--Дополнительные типы траффика для оффера-->
- <item>
- <id>int <!--id типа траффика--></id>
- <value>boolean <!--доступен/недоступен--></value>
- <note>string <!--описание--></note>
- <name>string <!--название типа траффика--></name>
</item>
</additional-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> - <offer_logo>string <!--Offer logo link--></offer_logo>
- <offer_logo_svg>string <!--Offer svg logo link--></offer_logo_svg>
- <approval_time>string</approval_time>
- <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 1 click in one week--></epc7days>
- <epc90days>string <!--Webmaster income from 1 click in three months--></epc90days>
- <cpo7days>string</cpo7days>
- <cpo90days>string</cpo90days>
- <screen>string <!--Site screenshot--></screen>
- <is_exclusive>boolean</is_exclusive>
- <tags>
</tags>
</item>
</items>
</data>
</getOffersResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offers/web?remote_auth=6420072d37bf14f1df182d0fe0efa2d9offer-links
Format:
GET /api/rest/webmaster/xml/offer-links/{id}?traffic_channel_id=<int>
Descritption:
Returns the list of offer's links
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | id | offer identifier | | |
int | traffic_channel_id | filter by traffic channels. Integer identifier. See traffic channels guide | | |
Response:
- <getOfferLinkListResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <items>
- <item>
- <title>string <!--Link type--></title>
- <is_default>boolean</is_default>
- <deep_link>string <!--Straight link--></deep_link>
</item>
</items>
</data>
</getOfferLinkListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offer-links/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9offer
Format:
GET /api/rest/webmaster/xml/offer/{id}
Descritption:
Returns detail information about an offer
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | id | offer 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>
- <is_deeplink_enabled>boolean</is_deeplink_enabled>
- <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_transactions>
- <item>
- <value>boolean</value>
- <note>string</note>
- <name>string</name>
</item>
</terms_transactions>
</data>
</getOfferResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offer/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9offertarget
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: |
---|
int | id | offer 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>
- <cpl_max>string</cpl_max>
- <cps>string</cps>
- <cps_max>string</cps_max>
- <is_personal>boolean</is_personal>
</item>
</items>
</data>
</getOfferTargetResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offertarget/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9analytics-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: |
---|
string | site | | | |
enum | months | | 1, 3, 6, 12 | |
Response:
- <getAnalyticsAudienceResponseData>
- <status></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>
</audience-reach>
<audience-time></audience-time>
<audience-pages></audience-pages>
<audience-bounce></audience-bounce></data></getAnalyticsAudienceResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/analytics-audience/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9analytics-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: |
---|
string | site | | | |
enum | months | | 1, 3, 6, 12 | |
Response:
- <getAnalyticsGeoResponseData>
- <status></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=6420072d37bf14f1df182d0fe0efa2d9analytics-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: |
---|
string | site | | | |
enum | months | | 1, 3, 6, 12 | |
Response:
- <getAnalyticsOutgoingTrafficResponseData>
- <status></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=6420072d37bf14f1df182d0fe0efa2d9analytics-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: |
---|
string | site | | | |
Response:
- <getAnalyticsCompetitorsResponseData>
- <status></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