Documentation

GetAllSegments

Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.

Request Details

Request has no paramaters.

GetAllSegmentsRequest
Request Properties
POST https://{{TitleID}}.playfabapi.com/Admin/GetAllSegments
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{}
        

Response Details

GetAllSegmentsResult
Result Properties
Segments List<GetSegmentResult>

Array of segments for this title.

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