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

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

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

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

Get the personalization strategy.

Examples

The Algolia CLI lets you perform many tasks on your Algolia resources from your terminal without having to write any code. Read the Algolia CLI documentation for more information.

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

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
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?