Rest API Анализ корзин - datawizio/pythonAPI GitHub Wiki

41. Ресурс `/pairs/ POST`

Анализ корзин. С помощью ресурса /pairs/ можно определить типичные корзины покупателей в торговой сети в разное время, разной стоимости и размера.

41.1. POST-параметры:

Название поля	Тип поля	Доступные значения	Значение по умолчанию	Описание
`format`	строка	"json", "api"	"json"	Формат ответа сервера
`product_id`	число	-	Все товары	Идентификатор товара
`category_id`	число	-	Все категории	Идентификатор категории
`level`	число	-	1	Уровень для анализа, начиная с первого (категории -> подкатегории -> .. -> товары)
`shops`	число, список	-	Все магазины	Идентификатор магазина
`hours`	число, список	0 - 23	Весь день	Часы, по которым осуществлять выборку
`price_from`	число	-	0	Минимальная цена товара
`price_to`	число	-	10000	Максимальная цена товара
`week_day`	число, строка	0 - 6, "all"	"all"	День недели, по которому осуществить выборку
`date_from`	строка	-	Дата последней подгрузки клиента - 30 дней	Начальная дата выборки
`date_to`	строка	-	Дата последней подгрузки клиента	Конечная дата выборки
`interval`	строка	"days", "weeks", "months", "years"	"days"	Интервал для выборки

41.1.2. Параметры ответа:

Название поля	Тип поля	Обязательно присутствует в ответе	Описание
`product_1`	число	да	Идентификатор сопутствующего товара
`product_2`	число	нет	Идентификатор сопутствующего товара
`product_...`	число	нет	Идентификатор сопутствующего товара
`product_5`	число	нет	Идентификатор сопутствующего товара
`product_1_name`	число	да	Название сопутствующего товара
`product_2_name`	число	нет	Название сопутствующего товара
`product_..._name`	число	нет	Название сопутствующего товара
`product_5_name`	число	нет	Название сопутствующего товара
`confidence`	число	да	Достоверность
`support`	число	да	Поддержка
`receipts_qty`	число	да	Кол-во чеков, в которых встречается типичная корзина
`avg_number_of_items_in_check`	число	да	Средний размер чеков с типичной корзиной
`avg_receipt`	число	да	Cредняя стоимость чеков, в которые попала типичная корзина

41.2. Пример работы с ресурсом

Команда: POST http://api.datawiz.io/api/v1/pairs/

Суффиксы (аналог параметра `format`):

.json - получить ответ с сервера в формате JSON
.api - получить ответ с сервера в формате HTML (тестовая платформа)

Пример POST-параметров:

{
  "shops": 674,
  "price_from": 10,
  "price_to": 200,
  "category_id": 75100,
  "level": 2
}

Ответ сервера:


HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
  "results": [
    {
      "confidence": 13.12,
      "product_2": "77226",
      "product_1": "76805",
      "support": 0.01621,
      "product_1_name": "Овощи",
      "avg_number_of_items_in_check": 5.68,
      "receipts_qty": 10623,
      "avg_receipt": 127.84,
      "id": "76805-77226",
      "product_2_name": "Хлебобулочные изделия"
    },
    {
      "confidence": 13.3,
      "product_2": "76174",
      "product_1": "75642",
      "support": 0.01643,
      "product_1_name": "Бакалея (соленая)",
      "avg_number_of_items_in_check": 6.02,
      "receipts_qty": 10768,
      "avg_receipt": 136.07,
      "id": "75642-76174",
      "product_2_name": "Бакалея (сладкая)"
    },
    {
      "confidence": 15.23,
      "product_2": "76174",
      "product_1": "76805",
      "support": 0.01882,
      "product_1_name": "Овощи",
      "avg_number_of_items_in_check": 6.02,
      "receipts_qty": 12332,
      "avg_receipt": 137.7,
      "id": "76805-76174",
      "product_2_name": "Бакалея (соленая)"
    },
    {
      "confidence": 13.05,
      "product_2": "75642",
      "product_1": "76805",
      "support": 0.01612,
      "product_1_name": "Овощи",
      "avg_number_of_items_in_check": 5.95,
      "receipts_qty": 10561,
      "avg_receipt": 142.98,
      "id": "76805-75642",
      "product_2_name": "Бакалея (сладкая)"
    }
  ]
}

Rest API Анализ корзин - datawizio/pythonAPI GitHub Wiki

41. Ресурс /pairs/ POST