API reference › Match reports

Download OpenAPI 3.0

Endpoints

GET /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/reports

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

  • Range
    string

    A range of requested items using the reports unit. The size of the range can not exceed 50. (see Pagination)

    Example: reports=0-49

Query Parameters

  • tournament_ids
    array

    Only return reports for the given list of tournaments.

    Example: 378426939508809728,534138941862841533

  • match_ids
    array

    Only return reports for the given list of matchs.

    Example: 2468971166855626795,436314459115419242

  • participant_ids
    array

    One or several participant ids involved in the reports to filter.

    Example: 618965416546776434,618975467354349191

  • custom_user_identifiers
    array

    A list of external custom user identifiers.

    Example: acme:account:1234,acme:account:1235

  • types
    array

    One or several report types to filter.

    Example: report,dispute

  • is_closed
    boolean

    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",
        "tournament_id": "534138941862841533",
        "match_id": "2468971166855626795"
    }
]
Structure (collection)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"

  • tournament_id
    string

    The id of tournament.

    Example: "534138941862841533"

  • match_id
    string

    The id of match.

    Example: "2468971166855626795"

POST /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/reports

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

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",
    "match_id": "2468971166855626795"
}
Structure (object)
  • note
    string|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_id
    string|null

    Optional

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    Optional

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • match_id
    string

    The id of match.

    Example: "2468971166855626795"

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",
    "tournament_id": "534138941862841533",
    "match_id": "2468971166855626795"
}
Structure (object)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"

  • tournament_id
    string

    The id of tournament.

    Example: "534138941862841533"

  • match_id
    string

    The id of match.

    Example: "2468971166855626795"

GET /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/reports/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • id
    string

    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",
    "tournament_id": "534138941862841533",
    "match_id": "2468971166855626795"
}
Structure (object)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"

  • tournament_id
    string

    The id of tournament.

    Example: "534138941862841533"

  • match_id
    string

    The id of match.

    Example: "2468971166855626795"

PATCH /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/reports/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • id
    string

    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)
  • note
    string|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_id
    string|null

    Optional

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    Optional

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    Optional

    The report data.

  • closed
    boolean

    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",
    "tournament_id": "534138941862841533",
    "match_id": "2468971166855626795"
}
Structure (object)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"

  • tournament_id
    string

    The id of tournament.

    Example: "534138941862841533"

  • match_id
    string

    The id of match.

    Example: "2468971166855626795"

LegacyGET /tournaments/{tournament_id}/matches/{match_id}/reports

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

  • Range
    string

    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_id
    string

    The id of the tournament to retrieve.

  • match_id
    string

    The id of the match.

Query Parameters

  • participant_ids
    array

    One or several participant ids involved in the reports to filter.

    Example: 618965416546776434,618975467354349191

  • types
    array

    One or several report types to filter.

    Example: report,dispute

  • is_closed
    boolean

    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)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"

LegacyPOST /tournaments/{tournament_id}/matches/{match_id}/reports

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament to retrieve.

  • match_id
    string

    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)
  • note
    string|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_id
    string|null

    Optional

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    Optional

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    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)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"

LegacyGET /tournaments/{tournament_id}/matches/{match_id}/reports/{id}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament to retrieve.

  • match_id
    string

    The id of the match.

  • id
    string

    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)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"

LegacyPATCH /tournaments/{tournament_id}/matches/{match_id}/reports/{id}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament to retrieve.

  • match_id
    string

    The id of the match.

  • id
    string

    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)
  • note
    string|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_id
    string|null

    Optional

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    Optional

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    Optional

    The report data.

  • closed
    boolean

    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)
  • note
    string|null

    Private note of a report, only visible to the organizers.

    Max. length: 1,000 characters

    Example: "A note on\ntwo lines\n"

  • user_id
    string|null

    The id of user.

    Example: "513743143408302391"

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • report
    object

    The report data.

  • participant_id
    string

    The id of participant.

    Example: "375143143408309123"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    string|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_id
    string|null

    The id of the organizer user that closed the report.

    Example: "513743143408302391"