Player Reports Web APIs

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

5 mins to read

API Endpoint

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

Sending new player reports

Policy

The client policy used must have either one of these permissions:

  • 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
NameValue
Content-Type application/json
Request Body
NameTypeDescriptionRequired
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. 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

Example Request

curl --location --request POST 'https://api.epicgames.dev/player-reports/v1/report' \
--header 'Content-Type: text/plain' \
--data-raw '{
"time": "2020-04-02T00:00:00.000Z",
"reportingPlayerId": "player_1",
"reportedPlayerId": "player_2",
"reasonId": 1,
"message":"This player is cheating",
"context" : "{\"key\": \"value\"}"
}'

Response

HTTP Response 201 - CREATED: Success.

Find Player Reports

Policy