API Endpoint
https://api.epicgames.dev/player-reports/v1/report
Sending new player reports
Policy
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.
Authorization
This call requires Bearer Token authorization with an EOS Client Auth access token, obtained from the Connect interface.
Request
| 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:
| Yes |
reasonId |
Integer | The report reason ID. It must be a valid ID. Refer to | 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 |
Example Request
Response
| HTTP Response 201 - CREATED: Success. |
Find Player Reports
Policy
The client policy used must have the following permission:
playerreports:findReportsForAnyUser: When the client has permission to get reports for any players.
Authorization
This call requires Bearer Token authorization with an EOS Client Auth access token, obtained from the Connect interface.
Request
| 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/definitionAPI endpoint for more information | No |
startTime |
String | Return reports issued after | No |
endTime |
String | Return reports issued before | 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:
Default value: time:desc | No |
Example Request
Response
| HTTP Response 200 - OK: Success. | ||
| HTTP Headers | ||
| Name | Value | |
Content-Type |
application/json | |
| JSON Payload | ||
| Name | Type | Description |
elements |
Array<Report> | List of reports |
paging | Object<Paging> | Pagination information |
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:
|
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 |
Example Response
Get Report Reason Definition
Policy
No special client permissions are needed to call the report definition API
Authorization
This call requires Bearer Token authorization with an EOS Client Auth access token, obtained from the Connect interface.
Request
| HTTP Request | GET /player-reports/v1/report/reason/definition | |
Example Request
Response
| HTTP Response 200 - OK: Success. | ||
| HTTP Headers | ||
| Name | Value | |
Content-Type |
application/json | |
| JSON Payload | ||
| Name | Type | Description |
elements |
Array<ReportReason> | List of report reasons |
ReportReason
| ReportReason | ||
| Name | Type | Description |
reasonId |
Integer | The report reason Id |
reasonString |
String | A String describing the reasonId |