Experimentation - Get Experiments

Service:

Experimentation

API Version:

240412

Gets the details of all experiments for a title.

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

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.).

Responses

Name	Type	Description
200 OK	GetExperimentsResult
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
Experiment
ExperimentState
ExperimentType
GetExperimentsRequest	Given a title entity token will return the list of all experiments for a title, including scheduled, started, stopped or completed experiments.
GetExperimentsResult
Variable
Variant

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

Experiment

Name	Type	Description
Description	string	Description of the experiment.
EndDate	string	When experiment should end/was ended.
ExclusionGroupId	string	Id of the exclusion group for this experiment.
ExclusionGroupTrafficAllocation	number	Percentage of exclusion group traffic that will see this experiment.
ExperimentType	ExperimentType	Type of experiment.
Id	string	Id of the experiment.
Name	string	Friendly name of the experiment.
SegmentId	string	Id of the segment to which this experiment applies. Defaults to the 'All Players' segment.
StartDate	string	When experiment should start/was started.
State	ExperimentState	State experiment is currently in.
TitlePlayerAccountTestIds	string[]	List of title player account IDs that automatically receive treatments in the experiment, but are not included when calculating experiment metrics.
Variants	Variant[]	List of variants for the experiment.

ExperimentState

Name	Type	Description
Deleted	string
New	string
Started	string
Stopped	string

ExperimentType

Name	Type	Description
Active	string
Snapshot	string

GetExperimentsRequest

Given a title entity token will return the list of all experiments for a title, including scheduled, started, stopped or completed experiments.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

GetExperimentsResult

Name	Type	Description
Experiments	Experiment[]	List of experiments for the title.

Variable

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

Variant

Name	Type	Description
Description	string	Description of the variant.
Id	string	Id of the variant.
IsControl	boolean	Specifies if variant is control for experiment.
Name	string	Name of the variant.
TitleDataOverrideLabel	string	Id of the TitleDataOverride to use with this variant.
TrafficPercentage	number	Percentage of target audience traffic that will see this variant.
Variables	Variable[]	Variables returned by this variant.

Error Codes

Name	Code
FeatureNotConfiguredForTitle	1177