Player Reports Web APIs

Use the Player Reports Web APIs to use Player Reports interface features with RESTful services.

5 mins to read

https://api.epicgames.dev/player-reports/v1/report

The client policy used must have the following permission:

playerreports:sendReportForAnyUser: When the client has permission to send reports on behalf of any player. Typically when the reports are coming from a game server.

This call requires Bearer Token authorization with an EOS Client Auth access token, obtained from the Connect interface.

HTTP Request	`POST /player-reports/v1/report`
HTTP Headers
Name	Value
`Content-Type`	`application/json`
Request Body
Name	Type	Description	Required
`reportingPlayerId`	String	The EOS `productUserId` making the report	Yes
`reportedPlayerId`	String	The reported EOS `productUserId`. It must be different from the `reportingPlayerId`.	Yes
`time`	String	Time when the report was issued as defined in ISO 8601 and RFC3339. For example: `2021-01-01T00:00:00.000Z`	Yes
`reasonId`	Integer	The report reason ID. It must be a valid ID. Refer to `/player-reports/v1/report/reason/definition` API endpoint for more information	Yes
`message`	String	The report message with a maximum length of 1024 characters	No
`context`	String	Any valid Json. For any relevant information deemed useful for the developers. It has a maximum length of 4096 characters	No

HTTP Response 201 - CREATED: Success.

The client policy used must have the following permission:

playerreports:findReportsForAnyUser: When the client has permission to get reports for any players.

This call requires Bearer Token authorization with an EOS Client Auth access token, obtained from the Connect interface.

HTTP Request	`GET /player-reports/v1/report/{deploymentId}`
Request Parameters
Name	Type	Description	Required
`deploymentId`	String	The EOS `deploymentId`. It has to match the `deploymentId` generated by the access token	Yes
`reportingPlayerId`	String	The EOS `productUserId` making the report. `reportingPlayerId` and `reportedPlayerId` cannot both be empty	No
`reportedPlayerId`	String	The reported EOS `productUserId`. `reportingPlayerId` and `reportedPlayerId` cannot both be empty	No
`reasonId`	Integer	The report reason Id. It must be a valid id. Refer to */player-reports/v1/report/reason/definition* API endpoint for more information	No
`startTime`	String	Return reports issued after `startTime`. Time when the report was issued as defined in ISO 8601 and RFC3339. example: 2021-01-01T00:00:00.000Z	No
`endTime`	String	Return reports issued before `endTime`. Time when the report was issued as defined in ISO 8601 and RFC3339. For example: `2021-01-01T00:00:00.000Z`	No
`pagination`	Boolean	Enable/Disable pagination response. Default value : false	No
`offset`	Integer	The pagination offset Default value: 0	No
`limit`	Integer	The reports count returned per call Default value: 50	No
`order`	String	The order followed by returned reports: Possible values: `time:desc` `time:asc` `reasonId:asc` `reasonId:desc` Default value: time:desc	No

Paging

Paging
Name	Type	Description
`offset`	Integer	The pagination offset
`limit`	Integer	The reports count returned per call
`total`	Integer	The total reports count

Report

Report
Name	Type	Description
`productId`	String	The game EOS `productId`
`sandboxId`	String	The game EOS `sandboxId`
`deploymentId`	String	The game EOS `deploymentId`
`time`	String	Time when the report was issued as defined in ISO 8601 and RFC3339. For example: `2021-01-01T00:00:00.000Z`
`reportingPlayerId`	String	The EOS `productUserId` making the report
`reportedPlayerId`	String	The reported EOS `productUserId`
`reasonId`	Integer	The report `reasonId`
`message`	String	The report content
`context`	String	The report context

No special client permissions are needed to call the report definition API

This call requires Bearer Token authorization with an EOS Client Auth access token, obtained from the Connect interface.

HTTP Request	`GET /player-reports/v1/report/reason/definition`

ReportReason

ReportReason
Name	Type	Description
`reasonId`	Integer	The report reason Id
`reasonString`	String	A String describing the `reasonId`