Documentation

GetPlayerSegments

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

Request Details

GetPlayersSegmentsRequest
Request Properties
PlayFabId (required) String

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

POST https://{{TitleID}}.playfabapi.com/Server/GetPlayerSegments
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "1337AA00"
}
        

Response Details

GetPlayerSegmentsResult
Result Properties
Segments List<GetSegmentResult>

Array of segments the requested player currently belongs to.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Segments": [
      {
        "Id": "1337AA00",
        "Name": "Fast Players"
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code