Add strategy

Set a personalization strategy.

This page documents an earlier version of the API client. For the latest version, see Define the personalization strategy.

Required ACL: editSettings

Examples

C#

var strategy = new SetStrategyRequest
{
    EventsScoring =
        new List<EventsScoring>
        {
            new EventsScoring("Add to cart", "conversion", 50),
            new EventsScoring("Purchase", "conversion", 100)
        },
    FacetsScoring = new List<FacetsScoring>
    {
        new FacetsScoring("brand", 100),
        new FacetsScoring("categories", 10)
    },
    PersonalizationImpact = 50
};

client.SetPersonalizationStrategy(strategy);

Parameters

strategy · object · required

An object for configuring the Personalization strategy.

Show child attributes

eventsScoring · object[] · required

Associate a score to some events.

Example:

JSON

{
  "eventsScoring": [
    {
      "eventName": "purchase"
      "eventType": "conversion"
      "score": 100
    }
  ],
}

Show child attributes

eventName · string

Event name.

eventType · string

Event type: conversion, click, or view.

score · number

Score of the event.

facetsScoring · object[] · required

Associate a score to some facets.

Example:

JSON

{
  "facetsScoring": [
    {
      "facetName": "brand",
      "score": 100
    }
  ]
}

Show child attributes

facetName · string

Facet name

score · number

Score for this facet.

personalizationImpact · integer · required

The impact personalization has on the search results: a number between 0 (personalization disabled) and 100 (personalization fully enabled)

requestOptions · object

A mapping of request options to send along with the request.

Response

message · string

Response message.

status · integer

Response status code.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

{
  "status": 200,
  "message": "Strategy was successfully updated"
}