Количество товарных предложений на модель по регионам

Описание

GET /{version}/models/{id}/offers/stat

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

URL ресурса:

https://api.content.market.yandex.ru/{version}/models/{id}/offers/stat

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

Параметр Положе­ние Тип Обяза­тельность Описание
version PATH Enum Да

Версия API.

id PATH Int64 Да

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

format QUERY Enum Нет

Формат выходных данных.

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .

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

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

{
  "context" : {
    "region" : {
      "id" : {int32},
      "name" : "{string}",
      "type" : "{enum}",
      "childCount" : {int32},
      "country" : {
        Содержимое объекта
      }
    },
    "currency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "alternateCurrency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "warnings" : [
      {
        "type" : "{string}",
        "code" : "{string}",
        "message" : "{string}"
      },
      ...
    ],
    "id" : "{string}",
    "time" : "{date}",
    "link" : "{string}",
    "marketUrl" : "{string}"
  },
  "statistics" : {
    "regions" : [
      {
        "id" : {int32},
        "price" : {
          "max" : "{string}",
          "min" : "{string}",
          "median" : "{string}"
        },
        "offerCount" : {int32}
      },
      ...
    ]
  },
  "status" : "{enum}"
}

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

Параметр для формата JSON Параметр для формата XML Тип Описание
status status

Enum

Статус обработки запроса.

Возможные значения:
  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

context context

Object

Контекст обработки запроса.

statistics statistics

Object

Информация о кол-ве и ценах товарных предложений модели по регионам

result-context-v2 Параметры, вложенные в context
id id

String

Уникальный идентификатор запроса.

time time

Date

Дата и время выполнения запроса в формате ISO 8601.

link link

String

Ссылка на текущий запрос.

marketUrl marketUrl

String

Ссылка на Яндекс.Маркет.

region region

Object

Информация о регионе запроса.

currency currency

Object

Валюта запроса.

alternateCurrency alternateCurrency

Object

Альтернативная валюта запроса.

warnings warnings

Object list

Список предупреждений, возникших при обработке запроса.

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

region-v2 Параметры, вложенные в context/region
id id

Int32

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

name name

String

Наименование региона.

type type

Enum

Тип региона.

Возможные значения:
  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

Количество дочерних регионов.

country country

Object

Страна, к которой относится регион.

Регион

currency-v2 Параметры, вложенные в context/currency, context/alternateCurrency
id id

String

Код валюты.

name name

String

Название валюты.

warning Параметры, вложенные в context/warnings
type type

String

Тип предупрежедния.

code code

String

Код предупреждения.

message message

String

Сообщение с описанием предупреждения.

model-offer-statistic Параметры, вложенные в statistics
regions regions

Object list

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

model-offer-statistic-region-statistic Параметры, вложенные в statistics/regions
id id

Int32

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

offerCount offerCount

Int32

Количество товарных предложений модели в регионе

price price

Object

Информация о ценах модели в регионе

model-offer-statistic-price-range Параметры, вложенные в statistics/regions/price
max max

String

Максимальная цена

min min

String

Минимальная цена

median median

String

Медиана по ценам

Возможные ошибки

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.