Офферы

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>

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

• <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>
        • <additional-traffic-types> <!--Additional types of traffic for offer-->
          • <item>
            • <id>int <!--id типа траффика--></id>
            • <value>boolean <!--доступен/недоступен--></value>
            • <note>string <!--описание--></note>
            • <name>string <!--название типа траффика--></name>
            </item>
          </additional-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>
        • <offer_logo>string <!--ссылка на логотип--></offer_logo>
        • <offer_logo_svg>string <!--ссылка на логотип в формате svg--></offer_logo_svg>
        • <approval_time>string</approval_time>
        • <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>
        • <is_exclusive>boolean</is_exclusive>
        • <tags>
          • <item>string</item>
          </tags>
        </item>
      </items>
    </data>
  </getOffersResponseData>

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

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

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

GET /api/rest/webmaster/xml/offer-links/{id}?traffic_channel_id=<int>

Возвращает список ссылок оффера

• <getOfferLinkListResponseData>
  • <status>int</status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>
    • <total>int</total>
    • <items>
      • <item>
        • <title>string <!--Тип ссылки--></title>
        • <is_default>boolean <!--Ссылка по умолчанию--></is_default>
        • <deep_link>string <!--Прямая ссылка--></deep_link>
        </item>
      </items>
    </data>
  </getOfferLinkListResponseData>

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

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

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

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

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

• <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>
        • <cpl_max>string <!--комиссия за лид (max)--></cpl_max>
        • <cps>string <!--комиссия за продажу--></cps>
        • <cps_max>string <!--комиссия за продажу (max)--></cps_max>
        • <is_personal>boolean <!--флаг персональности, цель доступна конкретному вебмастеру--></is_personal>
        </item>
      </items>
    </data>
  </getOfferTargetResponseData>

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

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

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

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

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

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

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

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

Пример:
http://cityads.com/api/rest/webmaster/xml/analytics-input-traffic/aliexpress.com/3?remote_auth=6420072d37bf14f1df182d0fe0efa2d9

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

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

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

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

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

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

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

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

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