Documentation

GetPlayerSegments

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

Request Details

GetPlayerSegmentsRequest
Request Properties
POST https://{{TitleID}}.playfabapi.com/Client/GetPlayerSegments
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{}
        

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

SessionTicket

Possible Error Codes

Name Code