Experimentation - Get Exclusion Group Traffic

Gets the details of all exclusion groups for a title.

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

Request Header

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

Name	Required	Type	Description
ExclusionGroupId	True	string	The ID of the exclusion group.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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

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

Type: apiKey
In: header

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
ExclusionGroupTrafficAllocation
GetExclusionGroupTrafficRequest	Given a title entity token and an exclusion group ID, will return the list of traffic allocations for the exclusion group.
GetExclusionGroupTrafficResult

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

Name	Type	Description
ExperimentId	string	Id of the experiment.
TrafficAllocation	number	Percentage of exclusion group traffic that will see this experiment.

Given a title entity token and an exclusion group ID, will return the list of traffic allocations for the exclusion group.

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

Name	Type	Description
TrafficAllocations	ExclusionGroupTrafficAllocation[]	List of traffic allocations for the exclusion group.

Name	Code
ExperimentationExclusionGroupNotFound	7018
FeatureNotConfiguredForTitle	1177