Documentation

GetDataReport

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)

Sample Request

POST https://{{TitleID}}.playfabapi.com/Admin/GetDataReport
          Content-Type: application/json
		  X-SecretKey: <developer_secret_key>
{
  "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

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%2BIu5BCW0TL8ShQ%3D"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
InvalidParams 1000
InvalidReportDate 1111
ReportNotAvailable 1112