Базовая статистика

Описание

GET /campaigns/{campaignId}/stats/main
GET /campaigns/{campaignId}/stats/main-daily
GET /campaigns/{campaignId}/stats/main-weekly
GET /campaigns/{campaignId}/stats/main-monthly

Методы возвращают базовую статистику (клики, показы и расход) по магазину за запрашиваемый период времени. Максимальный период времени для получения статистики в одном запросе — 180 дней.

Статистика по кликам доступна за все время с момента размещения магазина.

Статистика по показам доступна за последние 30 дней размещения.

Статистика суммируется и выводится в зависимости от ресурса запроса:

  • /campaigns/{campaignId}/stats/main — для каждого дня запрашиваемого периода;

  • /campaigns/{campaignId}/stats/main-daily — для каждого дня запрашиваемого периода (аналогично /campaigns/{campaignId}/stats/main);

  • /campaigns/{campaignId}/stats/main-weekly — по неделям запрашиваемого периода;

  • /campaigns/{campaignId}/stats/main-monthly — по месяцам запрашиваемого периода.

URL ресурсов:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/main.[format]
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/main-daily.[format]
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/main-weekly.[format]
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/main-monthly.[format]

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

Параметр

Тип

Значение

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

campaignId

Int64

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

fromDate

Date

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

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

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

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

byEventtime

Boolean

Тип даты, используемой в отчете.

Возможные значения:
  • 1 / TRUE / true / YES / yes — в отчете используется дата события.

  • 0 / FALSE / false / NO / no — в отчете используется дата учета.

По умолчанию используется дата события.

byPlaces

Boolean

Признак группировки по местам размещения:
  • 1 / TRUE / true / YES / yes — группировать.
  • 0 / FALSE / false / NO / no — не группировать.

По умолчанию места размещения не группируются.

clickType

Int32

Фильтрация выходных данных по типу кликов.

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

  • 0 — обычный клик.

  • 1 — клик на номер телефона.

По умолчанию фильтрация не используется.

fields

Enum

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

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

Внимание. Важно учитывать регистр — все буквы должны быть строчными.
  • cpa — статистика по расходам на размещение предложений в рамках программы « Заказ на Маркете ».

    Внимание. Значение перестанет поддерживаться после закрытия программы «Заказ на Маркете».
    Ограничение. Значение cpa не работает, если во входных данных задан хотя бы один из следующих параметров: byPlaces с одним из следующих значений 1 / TRUE / true / YES / yes, clickType с любым возможным значением или fields со значением mobile.
  • mobile — статистика по кликам и расходам на мобильном сайте и в мобильных приложениях Яндекс.Маркета.

  • model — подробная информация о месте размещения предложения на карточке модели.

    Ограничение. Значение model работает, только если во входных данных задан параметр byPlaces с одним из следующих значений: 1 / TRUE / true / YES / yes.
  • shows — статистика по показам предложений.

    Ограничение. Значение shows не работает, если во входных данных задан параметр byEventtime со значением 0 или clickType с любым возможным значением.

В значении параметра можно комбинировать варианты, разделяя их запятой. Например, fields=mobile,model.

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

spendingFilter

Enum

Тип расходов на ставки, который нужно показать в выходных данных.

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

  • all — все расходы на ставки.

  • discounts — только дополнительные расходы на предложения со скидками.

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

toDate

Date

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

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

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

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

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.
<response>
  <main-stats>
    <main-stats-item accepted-orders="{int32}" accepted-orders-cpa-spending="{double}" accepted-orders-gmv="{double}" clicks="{int32}" created-orders="{int32}" created-orders-cpa-spending="{double}" created-orders-gmv="{double}" date="{date}" place-group="{int32}" shows="{int32}" spending="{double}">
      <detailed-stats>
        <stats clicks="{int32}" shows="{int32}" spending="{double}" type="{enum}"/>
      </detailed-stats>
    </main-stats-item>
    ...
  </main-stats>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

main-stats mainStats

Список статистических данных, сгруппированных по дням, неделям или месяцам (в зависимости от ресурса, указанного в запросе).

До версии 2.0 партнерского API Яндекс.Маркета параметр в формате JSON назывался main-stats.

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

main-stats-item

Статистика.

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

Параметры, вложенные в main-stats-item / mainStats

accepted-orders acceptedOrders Int32
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

Количество заказов, принятых магазином.

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

accepted-orders-cpa-spending acceptedOrdersCpaSpending Double
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

Общая комиссия за заказы, принятые магазином, в условных единицах. Комиссия учитывается за каждую единицу товаров на момент оформления заказов покупателями.

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

accepted-orders-gmv acceptedOrdersGmv Double
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

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

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

clicks clicks Int32

Количество кликов.

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

created-orders createdOrders Int32
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

Количество заказов, оформленных покупателями и поступивших в магазин для обработки.

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

created-orders-cpa-spending createdOrdersCpaSpending Double
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

Общая комиссия за заказы, оформленные покупателями, в условных единицах. Комиссия учитывается за каждую единицу товаров на момент оформления заказов.

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

created-orders-gmv createdOrdersGmv Double
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

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

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

date date Date

Дата, за которую приводится статистика, для ресурсов campaigns/{campaignId}/stat/main и campaigns/{campaignId}/stat/main-daily.

Дата начала недели, за которую приводится статистика, для ресурса campaigns/{campaignId}/stat/main-weekly.

Дата начала месяца, за который приводится статистика, для ресурса campaigns/{campaignId}/stat/main-monthly.

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

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

place-group placeGroup Int32

Идентификатор места размещения при заданной в запросе группировке по местам размещения (параметр входных данных byPlaces=1).

Возможные значения:
  • 3 — поиск Яндекс.Маркета.

  • 4 — карточки товаров.

    Примечание. Значение не выводится, если во входных данных задан параметр fields=model.
  • 5 — Яндекс.Маркет, кроме карточек товаров.

  • 6 — поиск Яндекса, Яндекс.Картинки, сторонние сайты и сервисы.

Если во входных данных указан параметр fields=model, дополнительные значения идентификатора места размещения непосредственно на карточке товара:

  • 7 — предложение по умолчанию.

  • 8 — специальные предложения «Заказ на Маркете».

    Внимание. Значение перестанет выводиться после закрытия программы «Заказ на Маркете».
  • 9 — блок «Топ-6».

  • 10 — остальные места на карточке.

Если группировка по местам размещения не задана в запросе, значение параметра равно 0.

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

shows shows Int32

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

spending spending Double

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

Выводится за день, неделю или месяц (в зависимости от ресурса, указанного в запросе).

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

detailed-stats detailedStats

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

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

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

stats

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

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

clicks clicks Int32

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

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

shows shows Int32

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

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

spending spending Double

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

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

type type Enum

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

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

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

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

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

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

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 400 Bad Request

Too long time period. Maximum is 'maxPeriod' days

Отчетный период, за который запрошена статистика, превышает максимальный отчетный период: maxPeriod.

Уменьшите отчетный период.

Примеры

Ресурс /campaigns/{campaignId}/stats/main

Статистика по:

  • расходам на размещение предложений в рамках программы «Заказ на Маркете»;

  • подробной информации о месте размещения предложения на карточке модели.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main.xml?fromDate=01-05-2017&fields=cpa,model&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item accepted-orders="94" accepted-orders-cpa-spending="74.33" accepted-orders-gmv="5670.32" clicks="10322" created-orders="330" created-orders-cpa-spending="454.52" created-orders-gmv="45452.1" date="2017-05-05" place-group="0" spending="331697"/>
    <main-stats-item accepted-orders="1" accepted-orders-cpa-spending="2.34" accepted-orders-gmv="5.67" clicks="9829" created-orders="8" created-orders-cpa-spending="9.10" created-orders-gmv="111.23" date="2017-05-10" place-group="0" spending="333915"/>
  </main-stats>
</response>

Статистика по:

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

  • показам предложений.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main.xml?fromDate=01-05-2017&fields=mobile,shows&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item clicks="6" date="2017-05-01" place-group="0" shows="7" spending="8.90">
      <detailed-stats>
        <stats clicks="1" shows="2" spending="3.45" type="mobile"/>
      </detailed-stats>
    </main-stats-item>
  </main-stats>
</response>

Ресурс /campaigns/{campaignId}/stats/main-daily

Статистика по:

  • расходам на размещение предложений в рамках программы «Заказ на Маркете»;

  • подробной информации о месте размещения предложения на карточке модели.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main-daily.xml?fromDate=01-05-2017&fields=cpa,model&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item accepted-orders="94" accepted-orders-cpa-spending="74.33" accepted-orders-gmv="5670.32" clicks="10322" created-orders="330" created-orders-cpa-spending="454.52" created-orders-gmv="45452.1" date="2017-05-05" place-group="0" spending="331697"/>
    <main-stats-item accepted-orders="1" accepted-orders-cpa-spending="2.34" accepted-orders-gmv="5.67" clicks="9829" created-orders="8" created-orders-cpa-spending="9.10" created-orders-gmv="111.23" date="2017-05-10" place-group="0" spending="333915"/>
  </main-stats>
</response>

Статистика по:

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

  • показам предложений.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main-daily.xml?fromDate=01-05-2017&fields=mobile,shows&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item clicks="6" date="2017-05-01" place-group="0" shows="7" spending="8.90">
      <detailed-stats>
        <stats clicks="1" shows="2" spending="3.45" type="mobile"/>
      </detailed-stats>
    </main-stats-item>
  </main-stats>
</response>

Ресурс /campaigns/{campaignId}/stats/main-weekly

Статистика по:

  • расходам на размещение предложений в рамках программы «Заказ на Маркете»;

  • подробной информации о месте размещения предложения на карточке модели.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main-weekly.xml?fromDate=01-05-2017&fields=cpa,model&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item accepted-orders="12" accepted-orders-cpa-spending="13.14" accepted-orders-gmv="1516.17" clicks="218899" created-orders="181" created-orders-cpa-spending="920.21" created-orders-gmv="22232.4" date="2017-05-05" place-group="0" spending="61047.11"/>
    <main-stats-item accepted-orders="25" accepted-orders-cpa-spending="2.62" accepted-orders-gmv="7.28" clicks="14050" created-orders="29" created-orders-cpa-spending="3.03" created-orders-gmv="132.33" date="2017-05-10" place-group="0" spending="4810.69"/>
  </main-stats>
</response>

Статистика по:

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

  • показам предложений.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main-weekly.xml?fromDate=01-05-2017&fields=mobile,shows&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item clicks="11" date="2017-05-01" place-group="0" shows="12" spending="1.31">
      <detailed-stats>
        <stats clicks="4" shows="5" spending="1.16" type="mobile"/>
      </detailed-stats>
    </main-stats-item>
  </main-stats>
</response>

Ресурс /campaigns/{campaignId}/stats/main-monthly

Статистика по:

  • расходам на размещение предложений в рамках программы «Заказ на Маркете»;

  • подробной информации о месте размещения предложения на карточке модели.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main-monthly.xml?fromDate=01-05-2017&fields=cpa,model&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item accepted-orders="17" accepted-orders-cpa-spending="18.19" accepted-orders-gmv="2021.22" clicks="328791" created-orders="23" created-orders-cpa-spending="242.52" created-orders-gmv="62728.2" date="2017-05-05" place-group="0" spending="740217.05"/>
    <main-stats-item accepted-orders="93" accepted-orders-cpa-spending="0.31" accepted-orders-gmv="3.23" clicks="140500" created-orders="333" created-orders-cpa-spending="4.35" created-orders-gmv="363738.39" date="2017-05-10" place-group="0" spending="88100.69"/>
  </main-stats>
</response>

Статистика по:

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

  • показам предложений.

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10002/stats/main-monthly.xml?fromDate=01-05-2017&fields=mobile,shows&toDate=10-05-2017'

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

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

<response>
  <main-stats>
    <main-stats-item clicks="40" date="2017-05-01" place-group="0" shows="41" spending="4.24">
      <detailed-stats>
        <stats clicks="3" shows="4" spending="4.1" type="mobile"/>
      </detailed-stats>
    </main-stats-item>
  </main-stats>
</response>