Статистика по предложениям

Описание

GET /campaigns/{campaignId}/stats/offers

Возвращает базовую статистику (клики и расход) по предложениям магазина за запрашиваемый период времени.

Возможна фильтрация предложений по поисковому запросу. Начиная с версии 2.0 партнерского API Яндекс.Маркета статистику можно получить для конкретного предложения при указании в запросе его идентификатора из прайс-листа.

Статистика по предложениям доступна за последние 30 дней (не включая текущий день).

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/offers.[format]

Входные данные

Параметр

Тип

Значение

Обязательные

campaignId

Int64

Идентификатор магазина.

fromDate

Date

Начальная дата отчетного периода.

Формат даты: ДД-ММ-ГГГГ.

Максимальный размер отчетного периода: 30 дней.

Необязательные

feedId

Int64

Идентификатор прайс-листа, содержащего предложение, для которого нужно получить статистику.

Обязательный, если в запросе указан параметр offerId, а у магазина зарегистрировано более одного прайс-листа.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

fields

Enum

Параметры, которые необходимо показать в выходных данных.

Возможные значения:

Внимание. Важно учитывать регистр — все буквы должны быть строчными.
  • mobile — статистика по кликам и расходам на мобильном сайте и в мобильных приложениях Яндекс.Маркета.

  • url — URL-адрес предложения на сайте магазина.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

offerId

String

Идентификатор предложения из прайс-листа, для которого нужно получить статистику.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

page

Int32

Номер страницы с результатами.

Если параметр не задан, выводится первая страница.

pageSize

Int32

Количество предложений, выводимых на странице с результатами поиска в ответе.

Значение по умолчанию: 10.

query

String

Поисковый запрос для фильтрации предложений, по которым нужна статистика. По умолчанию фильтрация не производится.

toDate

Date

Конечная дата отчетного периода.

Формат даты: ДД-ММ-ГГГГ.

Максимальный размер отчетного периода: 30 дней.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <offers-stats from-offer="{int32}" to-offer="{int32}" total-offers-count="{int32}">
    <offer-stats clicks="{int32}" feed-id="{int64}" offer-id="{string}" spending="{string}">
      <detailed-stats>
        <stats clicks="{int32}" spending="{string}" type="{enum}"/>
      </detailed-stats>
      <offer-name>{string}</offer-name>
      <url>{string}</url>
    </offer-stats>
    ...
  </offers-stats>
</response>
Структура выходных данных до версии 2.0 партнерского API Яндекс.Маркета
<offers-stats>
  <offers-stats from-offer="{int32}" to-offer="{int32}" total-offers-count="{int32}">
    <offer-stats clicks="{int32}" spending="{string}">
      <offer-name>{string}</offer-name>
    </offer-stats>
    ...
  </offers-stats>
</offers-stats>

Описание параметров:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

offers-stats offersStats

Список суммарных статистических данных.

Параметры, вложенные в offers-stats / offersStats

from-offer fromOffer Int32

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

Для формата XML является атрибутом параметра offers-stats.

to-offer toOffer Int32

Порядковый номер среди общих результатов поиска для последнего предложения на странице, выданной в ответе.

Для формата XML является атрибутом параметра offers-stats.

total-offers-count totalOffersCount Int32

Общее количество предложений в отчете.

Для формата XML является атрибутом параметра offers-stats.

offer-stats offerStats

Статистика по определенному предложению.

Параметры, вложенные в offer-stats / offersStats

clicks clicks Int32

Количество кликов по предложению.

Для формата XML является атрибутом параметра offer-stats.

feed-id feedId Int64

Идентификатор прайс-листа, содержащего предложение.

Для формата XML является атрибутом параметра offer-stats.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

offer-id offerId String

Идентификатор предложения из прайс-листа.

Для формата XML является атрибутом параметра offer-stats.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

spending spending String

Расход по кликам по предложению в условных единицах с учетом НДС.

Для формата XML является атрибутом параметра offer-stats.

detailed-stats detailedStats

Список подробных статистик.

Выводится, если в качестве входного задан параметр fields=mobile.

offer-name offerName String

Название предложения.

url url String

URL-адрес предложения на сайте магазина.

Параметры, вложенные в detailed-stats

stats

Подробная статистика.

Параметры, вложенные в stats / detailedStats

clicks clicks Int32

Количество кликов по предложению согласно типу статистики, указанному в параметре type.

Для формата XML является атрибутом параметра stats.

spending spending String

Расход по кликам по предложению согласно типу статистики, указанному в параметре type, в условных единицах с учетом НДС.

Для формата XML является атрибутом параметра stats.

type type Enum

Тип подробной статистики.

Возможные значения:

  • MOBILE — статистика по кликам и расходам на мобильном сайте и в мобильных приложениях Яндекс.Маркета.

Для формата XML является атрибутом параметра stats.

Описание ошибок

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Ограничения

Количество запросов к ресурсу, которое возможно выполнить в течение суток, рассчитывается индивидуально и зависит от следующих показателей:

  • количество предложений.

Примечание.

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, не разместивших еще предложения, ограничение равно 0. При размещении предложений этими магазинами ограничение пересчитывается только на следующий день.

Примеры

Пример запроса:

curl -i -H 'Content-Type: application/xml' 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/offers.xml?fromDate=26-01-2017&byEventtime=1&byPlaces=0&fields=mobile,url'

Пример ответа:

HTTP/1.1 200 OK
Date: Thu, 12 May 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <offers-stats from-offer="1" to-offer="1" total-offers-count="21739">
    <offer-stats clicks="474" feed-id="323204" offer-id="002000000001135" spending="52.86">
      <detailed-stats>
        <stats clicks="1" spending="3.14" type="mobile"/>
      </detailed-stats>
      <offer-name>PocketBook IQ 701, Dark Blue</offer-name>
      <url>http://www.example-shop.ru/product_page-docpage/</url>
    </offer-stats>
  </offers-stats>
</response>
Пример запроса до версии 2.0 партнерского API Яндекс.Маркета
curl -i -H 'Content-Type: application/xml' 'https://api.partner.market.yandex.ru/v1/campaigns/10002/stats/offers.xml?fromDate=19-09-2016'

Пример ответа:

HTTP/1.1 200 OK
Date: Mon, 26 Sep 2016 12:08:12 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <offers-stats from-offer="1" to-offer="10" total-offers-count="21739">
    <offer-stats clicks="474" spending="52.86">
      <offer-name>PocketBook IQ 701, Dark Blue</offer-name>
    </offer-stats>
    <offer-stats clicks="204" spending="174.04">
      <offer-name>Nokia N9 16 GB, Black</offer-name>
    </offer-stats>
    <offer-stats clicks="203" spending="20.30">
      <offer-name>PocketBook IQ 701, Glossy White</offer-name>
    </offer-stats>
    <offer-stats clicks="194" spending="161.02">
      <offer-name>Samsung GT-S5830 Galaxy Ace, Black</offer-name>
    </offer-stats>
    <offer-stats clicks="172" spending="213.56">
      <offer-name>Samsung GT-i9100 Galaxy S II, Noble Black</offer-name>
    </offer-stats>
    <offer-stats clicks="165" spending="81.67">
      <offer-name>Samsung GT-N7000 Galaxy Note</offer-name>
    </offer-stats>
    <offer-stats clicks="160" spending="78.37">
      <offer-name>Samsung GT-i9001 Galaxy S Plus 8 GB, Metallic Black</offer-name>
    </offer-stats>
    <offer-stats clicks="96" spending="10.17">
      <offer-name>Тамара Глоба "Самый полный гороскоп на 2012 год"</offer-name>
    </offer-stats>
    <offer-stats clicks="92" spending="18.40">
      <offer-name>Маскарадный костюм "Дед Мороз", размер 48-54</offer-name>
    </offer-stats>
    <offer-stats clicks="88" spending="16.26">
      <offer-name>LG P698 Optimus Net, Black</offer-name>
    </offer-stats>
  </offers-stats>
</response>