Get ranking mix configuration

Returns all ranking mix configurations keyed by type. There are typically two configurations: one for search results (search) and one for category listing pages (category).

Request

GET /ranking-mix-config

Headers

HeaderValue
AuthorizationBearer <token>

Example Request

GET /ranking-mix-config

Response

Returns a JSON object where each key is a configuration type and the value is the corresponding configuration.

Response Fields (per configuration)

FieldTypeDescription
idintegerUnique ID of the configuration record.
typestringConfiguration context: search or category.
activebooleanWhether ranking mix boosting is enabled for this context.
out_stock_at_the_endbooleanWhen true, out-of-stock products are pushed to the end of results.
viewintegerBoost weight for page view count (0–100).
basketintegerBoost weight for add-to-basket count (0–100).
newintegerBoost weight for new/recently added products (0–100).
profit_marginintegerBoost weight for profit margin (0–100).
ratingintegerBoost weight for product rating (0–100).
revenueintegerBoost weight for revenue generated (0–100).
soldintegerBoost weight for number of units sold (0–100).
variation_idintegerInternal variation identifier.

Example Response

{
  "search": {
    "id": 1,
    "type": "search",
    "active": true,
    "out_stock_at_the_end": true,
    "view": 10,
    "basket": 20,
    "new": 5,
    "profit_margin": 0,
    "rating": 15,
    "revenue": 25,
    "sold": 25,
    "variation_id": 0
  },
  "category": {
    "id": 2,
    "type": "category",
    "active": true,
    "out_stock_at_the_end": true,
    "view": 5,
    "basket": 10,
    "new": 10,
    "profit_margin": 0,
    "rating": 10,
    "revenue": 30,
    "sold": 35,
    "variation_id": 0
  }
}