Documentation

GetActionsOnPlayersInSegmentTaskInstance

Get information about a ActionsOnPlayersInSegment task instance.

Request Details

The result includes detail information that's specific to an ActionsOnPlayersInSegment task. To get a list of task instances with generic basic information, use GetTaskInstances.

GetTaskInstanceRequest
Request Properties
TaskInstanceId (required) String

ID of the requested task instance.

POST https://{{TitleID}}.playfabapi.com/Admin/GetActionsOnPlayersInSegmentTaskInstance
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "TaskInstanceId": "E52531B47B1761C7-4"
}
        

Response Details

GetActionsOnPlayersInSegmentTaskInstanceResult
Result Properties
Parameter ActionsOnPlayersInSegmentTaskParameter

Parameter of this task instance

Summary ActionsOnPlayersInSegmentTaskSummary

Status summary of the actions-on-players-in-segment task instance

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Summary": {
      "TaskInstanceId": "B67ACA247F49EF47-8",
      "StartedAt": "2016-08-23T12:33:14Z",
      "Status": "InProgress",
      "PercentComplete": 67.0,
      "EstimatedSecondsRemaining": 893.0,
      "TotalPlayersInSegment": 325901,
      "TotalPlayersProcessed": 218354
    },
    "Parameter": {
      "SegmentId": "502FD30E8C78F826",
      "ActionId": "FE29AED5399BED1F"
    }
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
TaskInstanceNotFound 1262