Player Data Management - Get Data Report

Service:

Admin

API Version:

241122

Retrieves a download URL for the requested report

POST https://titleId.playfabapi.com/Admin/GetDataReport

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
Day	True	number	Reporting year (UTC)
Month	True	number	Reporting month (UTC)
ReportName	True	string	Report name
Year	True	number	Reporting year (UTC)

Responses

Name	Type	Description
200 OK	GetDataReportResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GetDataReportRequest	Gets the download URL for the requested report data (in CSV form). The reports available through this API call are those available in the Game Manager, in the Analytics->Reports tab.
GetDataReportResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

GetDataReportRequest

Gets the download URL for the requested report data (in CSV form). The reports available through this API call are those available in the Game Manager, in the Analytics->Reports tab.

Name	Type	Description
Day	number	Reporting year (UTC)
Month	number	Reporting month (UTC)
ReportName	string	Report name
Year	number	Reporting year (UTC)

GetDataReportResult

Name	Type	Description
DownloadUrl	string	The URL where the requested report can be downloaded. This can be any PlayFab generated reports. The full list of reports can be found at: https://docs.microsoft.com/en-us/gaming/playfab/features/analytics/reports/quickstart.

Error Codes

Name	Code
InvalidReportDate	1111
ReportDataNotRetrievedSuccessfully	1597
ReportNotAvailable	1112