Experimentation - Get Exclusion Groups

Service:

Experimentation

API Version:

240412

Gets the details of all exclusion groups for a title.

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

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	GetExclusionGroupsResult
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
ExperimentExclusionGroup
GetExclusionGroupsRequest	Given a title entity token will return the list of all exclusion groups for a title.
GetExclusionGroupsResult

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

ExperimentExclusionGroup

Name	Type	Description
Description	string	Description of the exclusion group.
ExclusionGroupId	string	Id of the exclusion group.
Name	string	Friendly name of the exclusion group.

GetExclusionGroupsRequest

Given a title entity token will return the list of all exclusion groups for a title.

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

GetExclusionGroupsResult

Name	Type	Description
ExclusionGroups	ExperimentExclusionGroup[]	List of exclusion groups for the title.

Error Codes

Name	Code
FeatureNotConfiguredForTitle	1177