Experimentation - Get Treatment Assignment

Reference

Service:: Experimentation

API Version:: 240412

Gets the treatment assignments for a player for every running experiment in the title.

POST https://titleId.playfabapi.com/Experimentation/GetTreatmentAssignment

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.

Responses

Name	Type	Description
200 OK	GetTreatmentAssignmentResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
GetTreatmentAssignmentRequest	Given a title player or a title entity token, returns the treatment variants and variables assigned to the entity across all running experiments
GetTreatmentAssignmentResult
TreatmentAssignment
Variable

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

GetTreatmentAssignmentRequest

Given a title player or a title entity token, returns the treatment variants and variables assigned to the entity across all running experiments

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.

GetTreatmentAssignmentResult

Name	Type	Description
TreatmentAssignment	TreatmentAssignment	Treatment assignment for the entity.

TreatmentAssignment

Name	Type	Description
Variables	Variable[]	List of the experiment variables.
Variants	string[]	List of the experiment variants.

Variable

Name	Type	Description
Name	string	Name of the variable.
Value	string	Value of the variable.

Error Codes

Name	Code
ExperimentationClientTimeout	7005
ExperimentationTreatmentAssignmentDisabled	7011
ExperimentationTreatmentAssignmentFailed	7010
FeatureNotConfiguredForTitle	1177
InvalidEntityType	1373