API Reference / API Methods / Personalization / Get strategy

Aug. 16, 2022

Get Strategy

Required API Key: any key with the settings ACL

Method signature

$client->getPersonalizationStrategy();

client.get_personalization_strategy()

recommendation.getPersonalizationStrategy()

recommendation.getPersonalizationStrategy({
  // any requestOptions
})

client.get_personalization_strategy()

recommendationClient.getPersonalizationStrategy(
  requestOptions: RequestOptions? = nil,
  completion:  Result<PersonalizationStrategy> -> Void
)

suspend fun ClientSearch.getPersonalizationStrategy(
    requestOptions: RequestOptions? = null
): ResponsePersonalizationStrategy

client.GetPersonalizationStrategy();

client.getPersonalizationStrategy();

client.GetPersonalizationStrategy()

get personalizationStrategy

See code examples

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

Read the Algolia CLI documentation for more information.

Copy

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

1
2
3
4
5
GetStrategyResponse result = client.getPersonalizationStrategy();

// Asynchronous
CompletableFuture<GetStrategyResponse> result = 
  client.getPersonalizationStrategyAsync();

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

Copy

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

        


          eventsScoring

list of eventScoring

Score associated to each event

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


          facetsScoring

list of facetScoring

Score associated to each facet.

Copy
  {
    "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?