Documentation

ExportMasterPlayerData

Exports all associated data of a master player account

Request Details

Exports all data associated with the master player account, including data from all titles the player has played, such as statistics, custom data, inventory, purchases, virtual currency balances, characters, group memberships, publisher data, credential data, account linkages, friends list and PlayStream event history. Note, this API queues the player for export and returns a receipt immediately. Record the receipt ID for future reference. It may take some time before the export is available for download. Upon completion of the export, an email containing the URL to download the export dump will be sent to the notification email address configured for the title.

ExportMasterPlayerDataRequest
Request Properties
PlayFabId (required) String

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

POST https://{{TitleID}}.playfabapi.com/Admin/ExportMasterPlayerData
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "A68C908B66C23C5"
}
        

Response Details

ExportMasterPlayerDataResult
Result Properties
JobReceiptId String

An email with this job receipt Id containing the export download link will be sent to the title notification email address when the export is complete.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "JobReceiptId": "A101202A2CD049A0A93C9531DFB37DE8"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
AccountDeleted 1322
AccountNotFound 1001