Developers

Офферы

Описание методов API

offers
Формат:

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=<string>&shop_id=<string>&linksonly=<enum>&user_has_offer=<enum>&tools=<string>

Описание:

Возвращает список офферов. Список содержит: информацию по комиссиям за лид и продажу, данные о доходах вебмастера по каждому офферу. Полученные идентификаторы офферов могут быть использованы в сценариях, затрагивающих прочие методы API.

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
enumtypeтип оффера. См. справочник типов офферовweb, web_favourite, mobile, mobile_favourite
 
intstartномер текущей страницы. По умолчанию 0
 
intlimitколичество элементов на странице. По умолчанию 50, но не более 1000
 
enumsortсортировка по полюid, name, rating, cpl, cpa, epc7days, epc90days, cpo7days, cpo90days
 
enumsort_typeпорядок сортировкиasc, desc
 
stringqстрока поиска по ключевому слову в названии оффера
 
stringgeoФильтр по региону. Целочисленные идентификаторы перечисляются через запятую. См. справочник регионов
 
stringplatformsфильтр по мобильным платформам. Целочисленные идентификаторы перечисляются через запятую. См. справочник мобильных платформ
 
stringcategoriesфильтр по категориям. Целочисленные идентификаторы перечисляются через запятую. См. справочник категорий офферов
 
stringtraffic_typesфильтр по типу трафика. Целочисленные идентификаторы перечисляются через запятую. См. справочник видов трафика
 
stringtraffic_channel_idфильтр по каналам трафика. Целочисленные идентификаторы перечисляются через запятую.
 
stringshop_idидентификатор магазина в каталоге товаров. См. каталог товаров
 
enumlinksonlyполучить ссылки на офферы без данных статистикиtrue, false
 
enumuser_has_offerДоступность оффера вебмастеруtrue, false
 
stringtoolsфильтр по инструментам. Целочисленные идентификаторы перечисляются через запятую. См. справочник инструментов
 
Ответ:
  • <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 <!--название оффера--></name>
          • <user_has_offer> <!--доступность оффера вебмастеру-->
              0|1|
            </user_has_offer>
          • <cookie_ltv>string <!--время жизни cookie--></cookie_ltv>
          • <site>string <!--сайт оффера--></site>
          • <categories> <!--категории оффера-->
            • <item>
              • <main_id>int <!--id главной категории--></main_id>
              • <main_title>string <!--название главной категории--></main_title>
              • <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> <!--регионы оффера-->
            • <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> <!--список ссылок оффера-->
            • <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 <!--комиссия за лид--></cpl>
          • <cpa>string <!--комиссия за продажу--></cpa>
          • <rating>float <!--рейтинг оффера среди общего множества офферов--></rating>
          • <epc7days>string <!--доход вебмастера с тысячи кликов за семь дней--></epc7days>
          • <epc90days>string <!--доход вебмастера с тысячи кликов за три месяца--></epc90days>
          • <cpo7days>string <!--суммарный доход вебмастера за семь дней--></cpo7days>
          • <cpo90days>string <!--суммарный доход вебмастера за девяносто дней--></cpo90days>
          • <screen>string</screen>
          </item>
        </items>
      </data>
    </getOffersResponseData>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/offers/web?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
promo
Формат:

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

Описание:

Возвращает список Промо

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
intoffer_id
 
stringtraffic_channel_idфильтр по каналам трафика. Целочисленные идентификаторы перечисляются через запятую.
 
intstartномер текущей страницы. По умолчанию 0
 
intlimitколичество элементов на странице. По умолчанию 50, но не более 1000
 
Ответ:
  • <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>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/promo/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offer
Формат:

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

Описание:

Возвращает детальную информацию об оффере

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
intidидентификатор оффера
 
Ответ:
  • <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>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/offer/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offertarget
Формат:

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

Описание:

Возвращает цели оффера и выплаты по ним

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
intidидентификатор оффера
 
Ответ:
  • <getOfferTargetResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <items>
        • <item>
          • <id>int</id>
          • <service_area> <!--региональные настройки цели-->
            • <item>
              • <id>int <!--id гео--></id>
              • <code>string <!--код гео--></code>
              • <title>string <!--Регион--></title>
              </item>
            </service_area>
          • <restriction_on_geo> <!--ограничения цели по гео-->
            • <item>
              • <id>int <!--id гео--></id>
              • <code>string <!--код гео--></code>
              • <title>string <!--Регион--></title>
              </item>
            </restriction_on_geo>
          • <title>string <!--название цели--></title>
          • <cpl>string <!--комиссия за лид--></cpl>
          • <cps>string <!--комиссия за продажу--></cps>
          • <is_personal>boolean <!--флаг персональности, цель доступна конкретному вебмастеру--></is_personal>
          </item>
        </items>
      </data>
    </getOfferTargetResponseData>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/offertarget/4325?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-audience
Формат:

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

Описание:

Сводные показатели аналитики по сайту

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
stringsite
 
enummonths1, 3, 6, 12
 
Ответ:
  • <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>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/analytics-audience/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-geo
Формат:

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

Описание:

Соотношение трафика по странам

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
stringsite
 
enummonths1, 3, 6, 12
 
Ответ:
  • <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>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/analytics-geo/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-input-traffic
Формат:

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

Описание:

Аналитика по входящему трафику

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
stringsite
 
enummonths1, 3, 6, 12
 
Ответ:
analytics-outgoing-traffic
Формат:

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

Описание:

Аналитика по исходящему трафику

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
stringsite
 
enummonths1, 3, 6, 12
 
Ответ:
  • <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>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/analytics-outgoing-traffic/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-similar-sites
Формат:

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

Описание:

Схожие рекламодатели

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
stringsite
 
Ответ:
  • <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>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/analytics-similar-sites/aliexpress.com?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
analytics-competitors
Формат:

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

Описание:

Конкуренты в поиске

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
stringsite
 
Ответ:
  • <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>
Пример:
http://api.cityads.com/api/rest/webmaster/xml/analytics-competitors/aliexpress.com?remote_auth=6420072d37bf14f1df182d0fe0efa2d9