Documentation

GetTaskInstances

Query for task instances by task, status, or time range.

Request Details

Only the most recent 100 task instances are returned, ordered by start time descending. The results are generic basic information for task instances. To get detail information specific to each task type, use Get*TaskInstance based on its corresponding task type.

GetTaskInstancesRequest
Request Properties
StartedAtRangeFrom DateTime

Optional range-from filter for task instances' StartedAt timestamp.

StartedAtRangeTo DateTime

Optional range-to filter for task instances' StartedAt timestamp.

StatusFilter TaskInstanceStatus

Optional filter for task instances that are of a specific status.

TaskIdentifier NameIdentifier

Name or ID of the task whose instances are being queried. If not specified, return all task instances that satisfy conditions set by other filters.

POST https://{{TitleID}}.playfabapi.com/Admin/GetTaskInstances
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "StatusFilter": "Failed",
  "StartedAtRangeFrom": "2016-08-23T11:00:00Z"
}
        

Response Details

GetTaskInstancesResult
Result Properties
Summaries List<TaskInstanceBasicSummary>

Basic status summaries of the queried task instances. Empty If no task instances meets the filter criteria. To get detailed status summary, use Get*TaskInstance API according to task type (e.g. GetActionsOnPlayersInSegmentTaskInstance).

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Summaries": [
      {
        "TaskInstanceId": "12526BFE6B097261",
        "TaskIdentifier": {
          "Name": "EnableDailyHappyHour",
          "Id": "6DBF342F05464412"
        },
        "StartedAt": "2016-08-23T12:33:14Z",
        "CompletedAt": "2016-08-23T12:33:19Z",
        "Status": "Succeeded",
        "ScheduledByUserId": "8E615CDCDD836C31",
        "Type": "CloudScript"
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
TaskNotFound 1261