Experimentation - Start Experiment

Service:

Experimentation

API Version:

240412

Starts an existing experiment for a title.

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

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	Required	Type	Description
ExperimentId	True	string	The ID of the experiment to start.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	EmptyResponse
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
EmptyResponse
StartExperimentRequest	Given a title entity token and an experiment ID, this API starts the experiment.

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

EmptyResponse

StartExperimentRequest

Given a title entity token and an experiment ID, this API starts the experiment.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ExperimentId	string	The ID of the experiment to start.

Error Codes

Name	Code
ExperimentationExperimentNotFound	7002
ExperimentationExperimentRunning	7001
ExperimentationExperimentStopped	7000
FeatureNotConfiguredForTitle	1177