PlayFab API Documentation

Retrieves a download URL for the requested report

Request Properties

Name Type Required Description
ReportName String Report name
Year int32 Reporting year (UTC)
Month int32 Reporting month (UTC)
Day int32 Reporting year (UTC)

Request Details

Gets the download URL for the requested report data as csv. The reports available through this api are those available in Game Manager. Current ReportName values include: Daily Api Usage Details Report, Daily New User History Report, Daily Overview Report, Daily Real Money Purchase History Report, Daily Top Items Report, Daily Top Spender Report, Daily VC Purchase History Report, Monthly New User History Report, Monthly Overview Report, Monthly Real Money Purchase History Report, Monthly Top Items Report, Monthly Top Spender Report, Monthly Totals Report, Monthly VC Purchase History Report, Seven Day Retention Report.

Sample Request

copy
POST https://{{TitleID}}.playfabapi.com/Admin/GetDataReport
          Content-Type: application/json
          X-SecretKey: <title_key_value>{
  "ReportName": "PurchaseDataReport",
  "Year": 2014,
  "Month": 12,
  "Day": 5
}

Response Properties

Name Type Description
DownloadUrl String The URL where the requested report can be downloaded.

Sample Response

copy
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "DownloadUrl": "https://data-reports-dev.s3-us-west-1.amazonaws.com/2730/PurchaseDataReport/2014/12/5/data.json?AWSAccessKeyId=AKIAJB5VEITH4PHABPAA&Expires=1418151409&Signature=1cF0Xre4FETLW+Iu5BCW0TL8ShQ="
  }
}

Authentication

Title Secret Key

Possible Error Codes

Name Code
InvalidParams 1000
InvalidReportDate 1111
ReportNotAvailable 1112