v1

latestSwagger 2.0raw.githubusercontent.com2019-12-04171835.5 KB
Rank

Post Rank.

Submit a Personalizer rank request, to get which of the provided actions should be used in the provided context.

post/rank

Request body

contextFeaturesobject[]

Features of the context used for Personalizer as a dictionary of dictionaries. This depends on the application, and typically includes features about the current user, their device, profile information, aggregated data about time and date, etc. Features should not include personally identifiable information (PII), unique UserIDs, or precise timestamps.

excludedActionsstring[]

The set of action ids to exclude from ranking.

eventIdstring

Optionally pass an eventId that uniquely identifies this Rank event. If null, the service generates a unique eventId. The eventId will be used for associating this request with its reward, as well as seeding the pseudo-random generator when making a Personalizer call.

deferActivationboolean

Send false if it is certain the rewardActionId in rank results will be shown to the user, therefore Personalizer will expect a Reward call, otherwise it will assign the default Reward to the event. Send true if it is possible the user will not see the action specified in the rank results, because the page is rendering later, or the Rank results may be overridden by code further downstream.

Response

Success

eventIdstring

The eventId for the round trip from request to response.

rewardActionIdstring

The action chosen by the Personalizer service. This is the action your application should display, and for which to report the reward. This might not be the first found in 'ranking' if an action in the request in first position was part of the excluded ids.