Endpoints
- GET /tournaments/{tournament_id}/matches/{match_id}/reports
Retrieve the match reports of a match.
Authorized Access - POST /tournaments/{tournament_id}/matches/{match_id}/reports
Create a new match report in a match.
Authorized Access - GET /tournaments/{tournament_id}/matches/{match_id}/reports/{id}
Retrieve a single match report of a match.
Authorized Access - PATCH /tournaments/{tournament_id}/matches/{match_id}/reports/{id}
Update a match report in a match.
Authorized Access
GET /tournaments/{tournament_id}/matches/{match_id}/reports
Returns the match reports of the given match, using various filters. Match reports are only available for "duel" type matches.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/reports
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization) - Rangestring
A range of requested items using the
reports
unit. The size of the range can not exceed 50. (see Pagination)Example: reports=0-49
Path parameters
- tournament_idstring
The id of the tournament to retrieve.
- match_idstring
The id of the match.
Query Parameters
- participant_idsarray
One or several participant ids involved in the matches to filter.
Example: 618965416546776434,618975467354349191
- typesarray
One or several match statuses to filter.
Example: report,dispute
- is_closedboolean
Whether to include scheduled matches.
Possible values: 0, 1
Request Body
This endpoint does not require a request body.
Response
[206] Match reports retrieved.
Example
[ { "note": "A note on\ntwo lines\n", "user_id": "513743143408302391", "custom_user_identifier": "acme:account:1234", "report": { "opponents": [ { "score": 15, "number": 1, "result": "win", "forfeit": false } ] }, "participant_id": "375143143408309123", "type": "report", "id": "168954615761461654", "closed": false, "closed_at": "2015-12-31T00:00:00+00:00", "closed_author_id": "513743143408302391" } ]
Structure (collection)
- notestring|null
Private note of a report, only visible to the organizers.
Max. length: 1,000 characters
Example: "A note on\ntwo lines\n"
- user_idstring|null
The id of user.
Example: "513743143408302391"
- custom_user_identifierstring|null
An external custom user identifier. Use the format that suits your needs.
Max. length: 100 characters
Example: "acme:account:1234"
- reportobject
The report data.
- participant_idstring
The id of participant.
Example: "375143143408309123"
- typestring
The type of the match report.
Possible values: dispute, report
- idstring
The id of the match report.
Example: "168954615761461654"
- closedboolean
Whether the match report is closed.
Example: false
- closed_atstring|null
The timestamp on which the match was played (a result was provided) in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-31T00:00:00+00:00"
- closed_author_idstring|null
The id of the organizer user that closed the report.
Example: "513743143408302391"
POST /tournaments/{tournament_id}/matches/{match_id}/reports
Create a new match report in a match, there can only be one report per participant.Match reports are only available for "duel" type matches. Trying to POST a new report in a "ffa" type match will result in a 403 Error.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/reports
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization)
Path parameters
- tournament_idstring
The id of the tournament to retrieve.
- match_idstring
The id of the match.
Query Parameters
This endpoint does not have any query parameters.
Request Body
Match report data.
Example
{ "note": "A note on\ntwo lines\n", "user_id": "513743143408302391", "custom_user_identifier": "acme:account:1234", "report": { "opponents": [ { "score": 15, "number": 1, "result": "win", "forfeit": false } ] }, "participant_id": "375143143408309123", "type": "report" }
Structure (object)
- notestring|null
Optional
Private note of a report, only visible to the organizers.
Max. length: 1,000 characters
Example: "A note on\ntwo lines\n"
- user_idstring|null
Optional
The id of user.
Example: "513743143408302391"
- custom_user_identifierstring|null
Optional
An external custom user identifier. Use the format that suits your needs.
Max. length: 100 characters
Example: "acme:account:1234"
- reportobject
The report data.
- participant_idstring
The id of participant.
Example: "375143143408309123"
- typestring
The type of the match report.
Possible values: dispute, report
Response
[201] Success
Example
{ "note": "A note on\ntwo lines\n", "user_id": "513743143408302391", "custom_user_identifier": "acme:account:1234", "report": { "opponents": [ { "score": 15, "number": 1, "result": "win", "forfeit": false } ] }, "participant_id": "375143143408309123", "type": "report", "id": "168954615761461654", "closed": false, "closed_at": "2015-12-31T00:00:00+00:00", "closed_author_id": "513743143408302391" }
Structure (object)
- notestring|null
Private note of a report, only visible to the organizers.
Max. length: 1,000 characters
Example: "A note on\ntwo lines\n"
- user_idstring|null
The id of user.
Example: "513743143408302391"
- custom_user_identifierstring|null
An external custom user identifier. Use the format that suits your needs.
Max. length: 100 characters
Example: "acme:account:1234"
- reportobject
The report data.
- participant_idstring
The id of participant.
Example: "375143143408309123"
- typestring
The type of the match report.
Possible values: dispute, report
- idstring
The id of the match report.
Example: "168954615761461654"
- closedboolean
Whether the match report is closed.
Example: false
- closed_atstring|null
The timestamp on which the match was played (a result was provided) in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-31T00:00:00+00:00"
- closed_author_idstring|null
The id of the organizer user that closed the report.
Example: "513743143408302391"
GET /tournaments/{tournament_id}/matches/{match_id}/reports/{id}
Returns the match report with the given id. Match reports are only available for "duel" type matches.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/reports/{id}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization)
Path parameters
- tournament_idstring
The id of the tournament to retrieve.
- match_idstring
The id of the match.
- idstring
The id of the match report to retrieve.
Query Parameters
This endpoint does not have any query parameters.
Request Body
This endpoint does not require a request body.
Response
[200] Match report retrieved.
Example
{ "note": "A note on\ntwo lines\n", "user_id": "513743143408302391", "custom_user_identifier": "acme:account:1234", "report": { "opponents": [ { "score": 15, "number": 1, "result": "win", "forfeit": false } ] }, "participant_id": "375143143408309123", "type": "report", "id": "168954615761461654", "closed": false, "closed_at": "2015-12-31T00:00:00+00:00", "closed_author_id": "513743143408302391" }
Structure (object)
- notestring|null
Private note of a report, only visible to the organizers.
Max. length: 1,000 characters
Example: "A note on\ntwo lines\n"
- user_idstring|null
The id of user.
Example: "513743143408302391"
- custom_user_identifierstring|null
An external custom user identifier. Use the format that suits your needs.
Max. length: 100 characters
Example: "acme:account:1234"
- reportobject
The report data.
- participant_idstring
The id of participant.
Example: "375143143408309123"
- typestring
The type of the match report.
Possible values: dispute, report
- idstring
The id of the match report.
Example: "168954615761461654"
- closedboolean
Whether the match report is closed.
Example: false
- closed_atstring|null
The timestamp on which the match was played (a result was provided) in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-31T00:00:00+00:00"
- closed_author_idstring|null
The id of the organizer user that closed the report.
Example: "513743143408302391"
PATCH /tournaments/{tournament_id}/matches/{match_id}/reports/{id}
Updates the match report with the given id. Match reports are only available for "duel" type matches.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/reports/{id}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization)
Path parameters
- tournament_idstring
The id of the tournament to retrieve.
- match_idstring
The id of the match.
- idstring
The id of the match report to retrieve.
Query Parameters
This endpoint does not have any query parameters.
Request Body
Match report data.
Example
{ "note": "A note on\ntwo lines\n", "user_id": "513743143408302391", "custom_user_identifier": "acme:account:1234", "report": { "opponents": [ { "score": 15, "number": 1, "result": "win", "forfeit": false } ] }, "closed": false }
Structure (object)
- notestring|null
Optional
Private note of a report, only visible to the organizers.
Max. length: 1,000 characters
Example: "A note on\ntwo lines\n"
- user_idstring|null
Optional
The id of user.
Example: "513743143408302391"
- custom_user_identifierstring|null
Optional
An external custom user identifier. Use the format that suits your needs.
Max. length: 100 characters
Example: "acme:account:1234"
- reportobject
Optional
The report data.
- closedboolean
Optional
Whether the match report is closed.
Example: false
Response
[200] Match report update.
Example
{ "note": "A note on\ntwo lines\n", "user_id": "513743143408302391", "custom_user_identifier": "acme:account:1234", "report": { "opponents": [ { "score": 15, "number": 1, "result": "win", "forfeit": false } ] }, "participant_id": "375143143408309123", "type": "report", "id": "168954615761461654", "closed": false, "closed_at": "2015-12-31T00:00:00+00:00", "closed_author_id": "513743143408302391" }
Structure (object)
- notestring|null
Private note of a report, only visible to the organizers.
Max. length: 1,000 characters
Example: "A note on\ntwo lines\n"
- user_idstring|null
The id of user.
Example: "513743143408302391"
- custom_user_identifierstring|null
An external custom user identifier. Use the format that suits your needs.
Max. length: 100 characters
Example: "acme:account:1234"
- reportobject
The report data.
- participant_idstring
The id of participant.
Example: "375143143408309123"
- typestring
The type of the match report.
Possible values: dispute, report
- idstring
The id of the match report.
Example: "168954615761461654"
- closedboolean
Whether the match report is closed.
Example: false
- closed_atstring|null
The timestamp on which the match was played (a result was provided) in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-31T00:00:00+00:00"
- closed_author_idstring|null
The id of the organizer user that closed the report.
Example: "513743143408302391"