API Reference / API Methods / Personalization / Get strategy
Required API Key: any key with the settings ACL
Method signature
$client->getPersonalizationStrategy();

About this method

You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Get the personalization strategy.

Examples

1
$strategy = $client->getPersonalizationStrategy();

Parameters

requestOptions
type: key/value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the request.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "eventsScoring": [
    {
      "eventName": "purchase"
      "eventType": "conversion"
      "score": 100
    }
  ],
  "facetsScoring": [
    {
      "facetName": "brand",
      "score": 100
    }
  ]
}
eventsScoring
list of eventScoring

Score associated to each event

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

Score associated to each facet.

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

eventScoring

eventName
string

Name of the event

eventType
string

Type of the event

score
number

Score of the event

facetScoring

facetName
string

Name of the facet

score
number

Score of the facet

Did you find this page helpful?