Play Stream - Get Player Segments

List all segments that a player currently belongs to at this moment in time.

POST https://titleId.playfabapi.com/Admin/GetPlayerSegments

Request Header

Name Required Type Description
X-SecretKey True

string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
PlayFabId True

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

CustomTags

object

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

Responses

Name Type Description
200 OK

GetPlayerSegmentsResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

GetPlayerSegmentsResult
GetPlayersSegmentsRequest
GetSegmentResult

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

GetPlayerSegmentsResult

Name Type Description
Segments

GetSegmentResult[]

Array of segments the requested player currently belongs to.

GetPlayersSegmentsRequest

Name Type Description
CustomTags

object

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

PlayFabId

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

GetSegmentResult

Name Type Description
ABTestParent

string

Identifier of the segments AB Test, if it is attached to one.

Id

string

Unique identifier for this segment.

Name

string

Segment name.

Error Codes

Name Code
SegmentNotFound 1220