API Reference / API Methods / Personalization / Add strategy
Required API Key: any key with the editSettings ACL
Method signature
$client->setPersonalizationStrategy(array strategy)

About this method # A

Set a personalization strategy.

Examples # A

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
$recommendation->setPersonalizationStrategy([
    'eventsScoring' => [
        [
            'eventName' => 'Add to cart',
            'eventType' => 'conversion',
            'score' => 50,
        ],
        [
            'eventName' => 'Purchase',
            'eventType' => 'conversion',
            'score' => 100,
        ],
    ],
    'facetsScoring' => [
        ['facetName' => 'brand', 'score' => 100],
        ['facetName' => 'categories', 'score' => 10],
    ],
    'personalizationImpact' => 50,
]);

Parameters # A

strategy #
type: object
Required

A strategy object.

{
  eventsScoring,
  facetsScoring,
  personalizationImpact
}
requestOptions #
type: key-value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the request.

strategy #

eventsScoring #
type: list of eventScoring
Required

Associate a score to some events

1
2
3
4
5
6
7
8
9
10
{
  "eventsScoring": [
    {
      "eventName": "purchase"
      "eventType": "conversion"
      "score": 100
    }
  ],
  ...
}
facetsScoring #
type: list of facetScoring
Required

Associate a score to some facets

1
2
3
4
5
6
7
8
9
{
  "facetsScoring": [
    {
      "facetName": "brand",
      "score": 100
    }
  ],
  ...
}
personalizationImpact #
type: integer
Required

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

eventScoring #

eventName #
type: string

Name of the event

eventType #
type: string

Type of the event

score #
type: number

Score of the event

facetScoring #

facetName #
type: string

Name of the facet

score #
type: number

Score of the facet

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

1
2
3
4
{
  "status": 200,
  "message": "Strategy was successfully updated"
}
status #
integer

Response status code

message #
string

Response message

Did you find this page helpful?
PHP v3